This page contains information on how to set up a Cloud VPS instance. What is a Cloud VPS instance? Difference between a Cloud VPS project and an instance
- A Cloud VPS project can be defined as the group of users and resources (like instances, security groups, floating IPs, Puppet groups, etc.) associated with a piece of software hosted on Cloud VPS.
- An instance is just one resource that a Cloud VPS project might use.
Why create a Cloud VPS instance?
Cloud VPS is a flexible option for those who need it. It is equivalent to having your own server(s).
Before requesting a Cloud VPS instance, we recommend you consider using Toolforge
instead. Toolforge has many of the same features as Cloud VPS, and Toolforge users do not have to manage the full virtual environment. Toolforge users also have access to toolsdb, wiki replicas, and a number of other services.
Who can create a Cloud VPS instance? Project admins
(sometimes written projectadmins). You must be a Project admin
in a project to create and manage its instances.
What are the responsibilities of project admins? Project admins must
subscribe to the cloud-announce
mailing lists and follow the maintenance or communication actions requested by the WMCS Admins. Failure to respond may result in unexpected loss of data or service interruptions.
Project admins should
delete unused instances and notify other admins when a project is no longer active. See Cloud VPS instance lifecycle
for more details.
Requesting Project admin rights
To create instances, individuals must have project admin rights on the specific project they want to have instances created for. The following people can grant Project admin rights:
- Project admins. Project admins can grant project admin rights on projects they belong to. You can find Project admins listed on the individual pages for their projects.
- Members of the cloudadmin group. Cloudadmin group members with two-factor authorization enabled can grant project admin rights on any project.
Project admins and members of the Cloud admin group can be contacted through the 'email a user' function or through their talk page on Wikitech. Please note: Many members of the Wikitech community are volunteers who may not check their email or talk pages regularly. You may need to check with more than one admin before you receive a response.
Before you create a Cloud VPS instance
- Be a Project admin in the project you intend to create an instance for.
- Make sure your project has an appropriate security group for the instance's networking needs.
- Be aware of your project's quotas (usage limits).
- Understand the Cloud VPS instance lifecycle.
Create a Cloud VPS instance
- Log in to https://horizon.wikimedia.org/.
- Use the dropdown at top to select the project you want to work on.
- Click Compute/Instances in the sidebar.
- Click the Launch instance button.
- Choose the parameters you want and launch the instance.
- Add instance information.
- Click Submit.
Add the following information to your instance:
* If the Project admin for the project has not created any additional security groups, besides the default group, you will only see the default security group listed.
Instance Sizes and Flavors
Cloud VPS sizes*
* Current as of April 2021
Manage a Cloud VPS instances
After you set your configurations and click Submit, it will take some time before the instance is ready. You will know your instance is ready when a new row appears in the instances list.
The following 4 areas are displayed:
Puppet Configuration for Cloud VPS instances Cloud VPS uses Puppet
to manage instance configurations.
If you are a sudo user for the project, you can run sudo puppet agent -tv or wait until puppet runs on your instance.
Setting up a test MediaWiki Server Increase quotas for projects
Quotas are the usage limits for projects. Quotas refer to one or more of CPU, RAM, disk storage, number of VM instances and/or floating IPs. The default quota for a new project allows up to 8 instances.
The Cloud VPS Instance lifecycle
Instances are allocated resources (storage, RAM, CPU, power). Over time, these resources need to be used or reclaimed. WMCS admins periodically check projects and instances to ensure they are being used by active projects. Instances will be removed for projects that have been determined inactive.
Process for removing Cloud VPS instances
- Notice will be sent to cloud via cloud-announce at least 2 weeks before any expected action is taken. Emergencies may require more immediate intervention.
- If possible, instances will be suspended or shut down for at least 2 weeks (a total of a month) before further unsolicited actions are taken to allow the tenant to notice.
- Inactive projects (those without instances or any responsive users) will be removed (along with their quota)
Backups of Cloud VPS instances
You can backup your server by copying the files you are interested to save on your local machine. OF course, this is not an automated process and you will need to store the data you are saving. Also, be mindful that backups may be very big and so you will be transferring a lot of data, which among other things will take a long time.
If you want to backup your root disk on your VPS server to a local directory named backup you can do the following:
rsync -aXvz --stats --info=progress2 --rsync-path="sudo /usr/bin/rsync" --exclude-from=./excludes.txt <server>:/ backup/`
The paths listed in the file excludes.txt
will be ignored. This gist
contains a common list of excluded paths that you usually do not need to backup since they are temporary files, cache, backups and other system files.
Communication and support
We communicate and provide support through several primary channels. Please reach out with questions and to join the conversation.
Communicate with us
Last edited on 16 July 2021, at 14:04
Content is available under CC BY-SA 3.0
unless otherwise noted.