You are browsing a read-only backup copy of Wikitech. The live site can be found at wikitech.wikimedia.org

User:Aklapper/Sandbox: Difference between revisions

From Wikitech-static
Jump to navigation Jump to search
imported>Aklapper
No edit summary
imported>Triciaburmeister
(Typo fixes; some restructuring to remove unnecessary depth; add in boxes to make content divisions clearer and easier to navigate)
Line 12: Line 12:
== Overview ==
== Overview ==


''Wikimedia Cloud Services (WMCS)'' provides tools, services, and support for technical collaborators who want to contribute to Wikimedia software projects.
''Wikimedia Cloud Services (WMCS)'' provides tools, services, and support for technical collaborators who want to contribute to Wikimedia software projects. Use Cloud Services to host your software tools for the [[meta:Wikimedia movement|Wikimedia movement]], without charge.


Use Cloud Services to host your software tools for the [[meta:Wikimedia movement|Wikimedia movement]], without charge.


Find out more:
{{ContentGrid
|content=
{{Colored box
|title = Data as a service
|content = [[#Quarry|Quarry]] and [[#PAWS|PAWS]] empower '''technically curious to advanced users''' to query wiki replicas and create scripts, tutorials, and data visualizations to analyze and improve Wikimedia projects.
}}


* 🎬 Video: [https://media.ccc.de/v/36c3-77-wikimedia-cloud-services-introduction Wikimedia Cloud Services introduction] (2019)
{{Colored box
* 📣 Slides: [[commons:File:Introduction_to_Wikimedia_Cloud_Services_-_Wikimania_Hackathon_2019_Stockholm_Sweden.pdf|An introduction to Cloud Services presentation]] (2019)
|title = Platform as a service
|content = [[#Toolforge|Toolforge]] is for '''intermediate to advanced users''' working on tools, bots, webservices that support Wikimedia projects.
}}


Support and administration of the WMCS resources is provided by the [[Mw:Wikimedia Cloud Services team|Wikimedia Foundation Cloud Services team]] and [[wmf:Volunteer_opportunities|Wikimedia movement volunteers]].
{{Colored box
|title = Infrastructure as a service
|content = [[#Cloud_VPS|Cloud VPS]] is for '''advanced users''' who need to administer their own servers for Wikimedia operations and software development.  
}}


== Services ==
}}
Decide which service is best for your needs.


=== Toolforge ===
== Toolforge ==


[[File:Toolforge_logo.svg|right|frameless|60px|alt=Toolforge|link=Portal:Toolforge]]
[[File:Toolforge_logo.svg|right|frameless|60px|alt=Toolforge|link=Portal:Toolforge]]
Line 40: Line 48:
For additional documentation and help with Toolforge, see [[Portal:Toolforge]].
For additional documentation and help with Toolforge, see [[Portal:Toolforge]].


=== Cloud VPS ===
== Cloud VPS ==


[[File:Wikimedia_Cloud_Services_logo.svg|right|frameless|60px|alt=Cloud Services|link=Portal:Cloud VPS]]
[[File:Wikimedia_Cloud_Services_logo.svg|right|frameless|60px|alt=Cloud Services|link=Portal:Cloud VPS]]
Line 52: Line 60:
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.
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? ====
=== 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.
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? ====
=== 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 [[Portal:Toolforge|Toolforge]] and the [[Nova_Resource:Deployment-prep|Beta Cluster]].
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 [[Portal:Toolforge|Toolforge]] and the [[Nova_Resource:Deployment-prep|Beta Cluster]].


====How does Cloud VPS work? ====
===How does Cloud VPS work? ===


Cloud VPS is a virtualization cluster and hosts various virtual machines (called instances) using [http://www.openstack.org/software/openstack-compute 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]].
Cloud VPS is a virtualization cluster and hosts various virtual machines (called instances) using [http://www.openstack.org/software/openstack-compute 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? ===
== What is the difference between Cloud VPS and Toolforge? ==


Cloud VPS is an [[:w:Cloud_computing#Infrastructure_as_a_service_.28IaaS.29|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.
Cloud VPS is an [[:w:Cloud_computing#Infrastructure_as_a_service_.28IaaS.29|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.
Line 70: Line 78:
Toolforge is a [[:w:Cloud_computing#Platform_as_a_service_.28PaaS.29|Platform as a service (PaaS)]] solution. It provides [[Help:Toolforge/Web|web servers]], [[Help:Toolforge/Database|databases]] and [[Help:Toolforge#Redis|other data storage]], and a [[Help:Toolforge/Grid|distributed job processing system]] as managed services that can be used by tools and their maintainers.
Toolforge is a [[:w:Cloud_computing#Platform_as_a_service_.28PaaS.29|Platform as a service (PaaS)]] solution. It provides [[Help:Toolforge/Web|web servers]], [[Help:Toolforge/Database|databases]] and [[Help:Toolforge#Redis|other data storage]], and a [[Help:Toolforge/Grid|distributed job processing system]] as managed services that can be used by tools and their maintainers.


=== Data Services ===
== Data Services ==


''[[Portal:Data Services|Data Services]]'' are a collection of products including private-information-redacted copies of Wikimedia's production wiki databases and access to [[dumps.wikimedia.org|Wikimedia Dumps]]. Use data services to create replicas of the production databases and other data for analysis and experimentation.  
''[[Portal:Data Services|Data Services]]'' are a collection of products including private-information-redacted copies of Wikimedia's production wiki databases and access to [[dumps.wikimedia.org|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:
There are also services to interact with data in a web browser: Quarry and PAWS.


==== Quarry ====
=== Quarry ===


[[File:Quarry-logo.svg|right|frameless|200px|alt=Quarry|link=meta:Research:Quarry]]
[[File:Quarry-logo.svg|right|frameless|200px|alt=Quarry|link=meta:Research:Quarry]]
Line 86: Line 94:
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 [[Help:MySQL_queries|SQL queries]].
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 [[Help:MySQL_queries|SQL queries]].


==== PAWS ====
=== PAWS ===


[[File:PAWS.svg|right|frameless|200px|alt=PAWS|link=PAWS]]
[[File:PAWS.svg|right|frameless|200px|alt=PAWS|link=PAWS]]
Line 96: Line 104:
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.
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? ===
== Which service is right for you? ==


{| class="wikitable"
{| class="wikitable"
Line 136: Line 144:
|
|
|-
|-
|Run webservices
|Run web services
|
|
|
|
Line 154: Line 162:
|
|
|-
|-
|Administrate your own virtual server
|Administer your own virtual server
|
|
|
|
Line 244: Line 252:


== Communication and support ==
== Communication and support ==
Please reach out with questions and join the conversation:
 
Support and administration of the WMCS resources is provided by the [[Mw:Wikimedia Cloud Services team|Wikimedia Foundation Cloud Services team]] and [[wmf:Volunteer_opportunities|Wikimedia movement volunteers]]. Please reach out with questions and join the conversation:


{{ContentGrid
{{ContentGrid
Line 282: Line 291:
* [[Portal:Data Services|Data Services Portal]] — Information about Data Services and links to help and technical documentation.
* [[Portal:Data Services|Data Services Portal]] — Information about Data Services and links to help and technical documentation.
* See the [[Help:Glossary|Glossary]] for detailed definitions of terms which are specific to Toolforge and Cloud VPS.
* See the [[Help:Glossary|Glossary]] for detailed definitions of terms which are specific to Toolforge and Cloud VPS.
* 🎬 Video: [https://media.ccc.de/v/36c3-77-wikimedia-cloud-services-introduction Wikimedia Cloud Services introduction] (2019)
* 📣 Slides: [[commons:File:Introduction_to_Wikimedia_Cloud_Services_-_Wikimania_Hackathon_2019_Stockholm_Sweden.pdf|An introduction to Cloud Services presentation]] (2019)


== Historical information ==
== Historical information ==

Revision as of 21:36, 31 January 2022





Poster-format overview

Overview

Wikimedia Cloud Services (WMCS) provides tools, services, and support for technical collaborators who want to contribute to Wikimedia software projects. Use Cloud Services to host your software tools for the Wikimedia movement, without charge.


Data as a service
Quarry and PAWS empower technically curious to advanced users to query wiki replicas and create scripts, tutorials, and data visualizations to analyze and improve Wikimedia projects.
Platform as a service
Toolforge is for intermediate to advanced users working on tools, bots, webservices that support Wikimedia projects.
Infrastructure as a service
Cloud VPS is for advanced users who need to administer their own servers for Wikimedia operations and software development.

Toolforge

Toolforge

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

Cloud Services

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

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 and PAWS.

Quarry

Quarry

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

PAWS

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)
Browser based
Terminal based
Write queries against replica databases
Run database dumps
Write and run bots
Run web services
Build tools to improve Wikimedia projects
Schedule or run continuous jobs
Administer your own virtual server
Need your own subdomain
Write documentation and create tutorials
Work with co-maintainers and co-admins
User knowledge curious—advanced curious—advanced intermediate—advanced advanced
Service concept Data as a service Data as a service Platform as a service Infrastructure as a service

Get started

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:

Please pay close attention to the following terms for Toolforge and Cloud VPS:

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.

You may also want to create an account in Phabricator, our project management system for tasks and bug reports.

Get started with Toolforge

{{#lst:Portal:Toolforge/Quickstart|quickstart}}

Get started with Cloud VPS projects

Join an existing project

  1. Choose a project to join with OpenStack browser.
  2. 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

  1. Follow the instructions on the "Cloud-VPS (Project-requests)" phabricator task.

Add members and admin users to a project

  1. Project admins can add new members or grant administrative permissions to members via https://horizon.wikimedia.org/project/member/
  2. Log your actions in #wikimedia-cloud connect that you added/granted admin permissions to the member.

Access an instance

See Help:Accessing Cloud VPS instances.

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.

You can add a log entry in the #wikimedia-cloud connect channel on Libera Chat by sending a message like: !log <projectname> <message>

Communication and support

Support and administration of the WMCS resources is provided by the Wikimedia Foundation Cloud Services team and Wikimedia movement volunteers. Please reach out with questions and join the conversation:

Discuss and receive general support
Receive mail announcements about critical changes
Subscribe to the cloud-announce@ mailing list (all messages are also mirrored to the cloud@ list)
Track work tasks and report bugs
Use the Phabricator workboard #Cloud-Services for bug reports and feature requests about the Cloud VPS infrastructure itself
Learn about major near-term plans
Read the News wiki page
Read news and stories about our work
Read the Cloud Services Blog (for the broader Wikimedia movement, see the Wikimedia Technical Blog)

(TODO: Remixed from Help:Cloud Services communication; merge back into template if acceptable)

Technology stack

WMCS is a computing ecosystem built on OpenStack, GridEngine, and Kubernetes. Cloud VPS projects use Horizon.

Learn more

Historical information

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.