You are browsing a read-only backup copy of Wikitech. The live site can be found at wikitech.wikimedia.org
|WIP - See phab:T292811 about trying to merge the four pages Help:Cloud Services Introduction, Help:At a glance: Cloud VPS and Toolforge, Help:Getting Started, User:SRodlund/servicedecisions (staging) potentially into one page.|
|wmflabs.org and wmcloud.org redirect here. You might be looking for the Lists of Toolforge tools or the List of Cloud VPS projects.|
Wikimedia Cloud Services (WMCS) provides tools, services, and support for technical collaborators who want to contribute to Wikimedia software projects.
It is available for use by anyone connected with the Wikimedia movement without charge. Support and administration of the WMCS resources is provided by the Wikimedia Foundation Cloud Services team and Wikimedia movement volunteers.
Find out more:
- 🎬 Video: Wikimedia Cloud Services introduction (2019)
- 📣 Slides: An introduction to Cloud Services presentation (2019)
(TODO) Examples of what you can do by running software on Cloud Services include:
- Build a tool that suggests wiki pages that need editing/maintenance
- Find out which articles on a Wikipedia mention cats
Decide which service is best for your needs.
Toolforge is one of the projects hosted by Wikimedia Cloud VPS. It is a shared hosting (platform as a service) environment for volunteers to develop and run tools, continuous bots, web services, scheduled jobs, and data analysis.
To use Toolforge you will need some programming knowledge, an understanding of Unix command line, and version control via Gerrit and Git.
Users of the Toolforge project create so-called "tool" accounts (technically service groups) which allow one or more users to collaborate to manage the software source code, configuration, and jobs for that tool or bot.
The Toolforge administrators manage a pool of virtual servers that provide a shared project hosting environment that can be used by Toolforge users. These resources include web servers, databases and other data storage, and a distributed job processing system. These services provide a reliable and scalable hosting environment for volunteers to develop and operate their tools and bots.
For additional documentation and help with Toolforge, see Portal:Toolforge.
Cloud VPS (Virtual Private Server) is a cloud computing environment powered by OpenStack. It offers collaboratively owned collections of virtual private servers. You can use this infrastructure to create and maintain open source software projects that help the Wikimedia movement.
The environment includes access to a variety of data services. Cloud VPS allows developers and system administrators to try out improvements to Wikimedia infrastructure (including MediaWiki), power research and analytics, and host projects that are not viable in the Toolforge environment.
Cloud VPS is for the advanced users to get involved in Wikimedia operations and software development. Cloud VPS contains many projects, each of which uses one or more instances.
Cloud VPS instances must go through a request and approval processes. Instances are not permanent and are reviewed periodically for potential deletion/removal. Cloud VPS instances are resource intensive. Before requesting, explore whether Toolforge or another service will adequately meet your needs.
How is Cloud VPS organized?
Cloud VPS is divided into projects. Each project has separate members and administrators who can create and maintain virtual machines ("instances") for use by that project. Each project can have own its own access policies, DNS records, etc.
What is a Cloud VPS project?
A project is a unit of privilege separation inside the Cloud VPS environment. Each project has separate management of membership, virtual machines, HTTPS proxies, firewall rules, etc. Examples of projects include Toolforge and the Beta Cluster.
How does Cloud VPS work?
Cloud VPS is a virtualization cluster and hosts various virtual machines (called instances) using OpenStack Compute. This is slightly different from your normal servers that you ssh to (i.e. Toolserver), as virtual machines do not exist physically, but reside inside a much bigger machine called the host machine. More details about the physical setup of Cloud VPS can be found under Portal:Cloud VPS/Infrastructure.
What is the difference between Cloud VPS and Toolforge?
Cloud VPS is an Infrastructure as a service (IaaS) solution. It provides virtual machines, storage, firewall, and HTTPS proxy resources to projects. The members of each individual project are responsible for managing applications, data, runtime, middleware, and operating systems themselves.
Toolforge is a Platform as a service (PaaS) solution. It provides web servers, databases and other data storage, and a distributed job processing system as managed services that can be used by tools and their maintainers.
Data Services are a collection of products including private-information-redacted copies of Wikimedia's production wiki databases and access to Wikimedia Dumps. Use data services to create replicas of the production databases and other data for analysis and experimentation.
There are also services to interact with data in a web browser:
Quarry is a public querying interface for Wiki Replicas, a set of live replica SQL databases of public Wikimedia Wikis. Quarry is designed to make running queries against Wiki Replicas easy. Quarry also provides a means for researchers to share and review each other's queries.
Quarry queries are run by individual users. They can be saved and published and forked by other users.
To use Quarry you need only a Wikimedia login and a web browsers. Quarry can be used by individuals with understanding along the technical spectrum. A basic understanding of SQL is recommended. Learn about SQL queries.
PAWS is a Jupyter notebook installation hosted by Wikimedia. PAWS notebooks can be used for creating tutorials, running live code, creating data visualizations, running bots using Pywikibot, and more.
PAWS notebooks are maintained by a single user. They can be downloaded and forked by other users.
To use PAWS you need only a Wikimedia login and a web browser. PAWS can be used by individuals with understanding along the technical spectrum. A knowledge of Python is helpful, but not required.
Which service is right for you?
|Activity / Needs||Quarry (DaaS)||PAWS (DaaS)||Toolforge (PaaS)||Cloud VPS (IaaS)|
|Write queries against replica databases||✔||✔||✔|
|Run database dumps||✔||✔|
|Write and run bots||✔||✔|
|Build tools to improve Wikimedia projects||✔|
|Schedule or run continuous jobs||✔|
|Administrate your own virtual server||✔|
|Need your own subdomain||✔|
|Write documentation and create tutorials||✔|
|Work with co-maintainers and co-admins||✔||✔|
|Service concept||Data as a service||Data as a service||Platform as a service||Infrastructure as a service|
Make sure to review and agree to our terms and conditions. Account Holders who plan to use WMCS resources and products must read and agree to the following:
- Code of Conduct for technical spaces
- Agreement to disclosure of personally identifiable information (which covers End-Users).
Please pay close attention to the following terms for Toolforge and Cloud VPS:
- Toolforge tools must be open source software licensed under an OSI approved license.
Set up your accounts
- Wikimedia account — this is the single user login (SUL) account you use to contribute to Wikipedia and its sister projects. When you create your Wikimedia account, you will create a username and password.
- Wikimedia developer account — this account is used to log into this wiki, Toolforge, Cloud VPS, Gerrit (our code review system for patches) and other protected Wikimedia Services. When you create your Wikimedia developer account, you will create a username (sometimes called LDAP username), UNIX shell username, and password.
- Note that while GitHub contains many of our public repos, you can only make pull requests for Cloud Services projects via Gerrit. Other wiki projects may use GitHub exclusively.
- Gerrit — Once you have set up the two accounts above, including your UNIX shell username, set up your SSH keys in Gerrit.
Get started with Toolforge
Get started with Cloud VPS projects
Join an existing project
- Choose a project to join with OpenStack browser.
- Request membership by creating a Phabricator task and assigning it directly to the project administrator(s).
- You can find the list of project admins by going to https://openstack-browser.toolforge.org/project/<project-name>.
Create a new project
- Follow the instructions on the "Cloud-VPS (Project-requests)" phabricator task.
Add members and admin users to a project
- Project admins can add new members or grant administrative permissions to members via https://horizon.wikimedia.org/project/member/
- Log your actions in #wikimedia-cloud connect that you added/granted admin permissions to the member.
Access an instance
Learn about project instances
To learn more about project instances, read the project instances documentation.
Log your actions
It is best practice to log changes to all instances of your project. Wikimedia Cloud Services provides a Server Admin Log for users to log their project server administration actions on.
Communication and support
Please reach out with questions and join the conversation:
(TODO: Remixed from Help:Cloud Services communication; merge back into template if acceptable)
- Toolforge Portal — Information about Toolforge and links to help and technical documentation.
- Cloud VPS Portal — Information about Cloud VPS and links to help and technical documentation.
- Data Services Portal — Information about Data Services and links to help and technical documentation.
- See the Glossary for detailed definitions of terms which are specific to Toolforge and Cloud VPS.
From 2011 until early 2017, Wikimedia Cloud Services was known as Wikimedia Labs. However, the term Labs was used for several different things.
Since 2017, the former Wikimedia Foundation Labs team and Tool Labs Support team merged into the Wikimedia Cloud Services team.