Help:Cloud Services introduction: Difference between revisions

From Wikitech
Browse history interactively
← Older editNewer edit →
Content deleted Content added
VisualWikitext
m Reverted edits by NoobThreePointOh (talk) to last revision by Majavah
Tag: Rollback
(178 intermediate revisions by 52 users not shown)
Line 1: Line 1:
[[File:What is Cloud Services? poster.pdf|alt=A Poster showing some Wikimedia Cloud services statistics and services|thumb|upright=1.3|Poster-format overview]]
'''Wikimedia Cloud Services''' ('''WMCS''') is a flexible computing ecosystem built on [[W:OpenStack|OpenStack]], [[W:Oracle Grid Engine|GridEngine]], and [[W:Kubernetes|Kubernetes]]. The project empowers technical contribution to the Wikimedia software world. The products and resources of the WMCS project are available for use by anyone connected with the [[meta:Wikimedia movement|Wikimedia movement]]. Support and administration of the WMCS resources is provided by a [[Mw:Wikimedia Cloud Services team|Wikimedia Foundation team]] and Wikimedia movement volunteers.
'''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:Special:MyLanguage/Wikimedia movement|Wikimedia movement]], without charge.


== What can you do with Cloud Services? ==
== Support and Administration ==


=== Host tools on Wikimedia servers ===
We use [[phab:project/profile/832/|Phabricator]], [[Help:IRC|IRC]], and [https://lists.wikimedia.org/mailman/listinfo/labs-l email] as primary support channels.
{{anchor|Toolforge|reason=Old section name.}}


Tools and bots make it easier to edit and maintain Wikimedia projects. For developers who support Wikimedia projects by developing tools and bots, '''[[Help:Toolforge | Toolforge]]''' provides the following features:
[[phab:tag/cloud-services/|Wikimedia Cloud Services]] are a joint effort between Foundation staff and many dedicated volunteers:
* Free, reliable, and scalable shared hosting, including web servers, databases and other data storage
* [[mw:Wikimedia Cloud Services team|Wikimedia Cloud Services team]]
* A distributed job processing system
* [[mw:Wikimedia Technical Operations|Wikimedia Technical Operations]]
* Support for multiple users to collaboratively maintain and manage tools
* [[meta:Community Liaisons|Community Liaisons]]
* [[Help:Tool_Labs/Tool Labs standards committee|Tool Labs standards committee]]
* [[phab:project/members/832/|Phabricator participants]]
* [[toollabs:openstack-browser/project/|Cloud VPS project]] maintainers
* [https://tools.wmflabs.org/?list Toolforge tool] maintainers
* and many more people who help by creating and maintaining documentation on this wiki and others in the Wikimedia movement


To use Toolforge you need:
== History ==
* Some programming knowledge
''A community consultation on branding has now been closed after an open call for participation and [[User:BryanDavis/Rebranding Cloud Services products|discussion]].''
* An understanding of Unix command line


To get started, visit [[Help:Toolforge]]. Or, [https://developer.wikimedia.org/build-tools/ learn more about creating bots].
Working titles are now in use across some documentation. The generic compute/'Labs' environment for running your own virtual instances is being referred to now as "VPS" and Tool Labs/Tools which is the PaaS environment is now being referred to as "Toolforge".


=== Run scripts and visualize data ===
----------
{{anchor|PAWS|reason=Old section name.}}
'''[[PAWS]]''' is a Jupyter notebook installation hosted by Wikimedia. PAWS notebooks can be used for creating tutorials, running live code, creating data visualizations, running basic bots, and more.


A single PAWS notebook is maintained by a single user, but they can be downloaded and forked by other users. To use PAWS you need only a Wikimedia login and a web browser. Knowledge of Python is helpful, but not required.
From 2011 until early 2017, WMCS was known as "Wikimedia Labs".


=== Administer servers for software development ===
The term 'Labs' became [[Labs labs labs|overloaded]] and often required clarification about what component of the ecosystem was being referred to. The former Wikimedia Foundation Labs team and the Tool Labs Support team have joined forces as the Wikimedia Cloud Services team and are launching a campaign to improve the language and branding surrounding products and services offered.
{{anchor|Cloud VPS|reason=Old section name.}}
Open source software projects help the Wikimedia movement by improving core infrastructure (like MediaWiki), powering research and analytics, and supporting Wikimedia operations and software development. For advanced projects that aren't viable in the Toolforge environment, '''[[Help:Cloud_VPS | Cloud VPS]]''' (Virtual Private Server) provides the following features:
* Free cloud computing environment, powered by [[:w:OpenStack|OpenStack]]
* Collaboratively-owned collections of virtual private servers, storage, firewall, and HTTPS proxy resources to projects
* Access to a variety of data services
* Freedom to install packages not provided by Debian or the Wikimedia Foundation
To use Cloud VPS, you need:
* An open source project that isn't viable in the Toolforge environment, or can't be accomplished using other WMCS offerings
* One or more active project maintainers who meet basic requirements
* Advanced programming knowledge
* Advanced experience with Unix command line
* The ability to administer your own servers and manage your project's applications, data, runtime, middleware, and operating systems


To get started, visit [[Help:Cloud VPS]].
== WMCS Products ==
* [[Portal:Wikimedia Labs|Virtual Private Servers ('''VPS''')]] for users to develop and maintain projects that help Wikimedia.
* [[Portal:Tool Labs|Toolforge Platform as a Service]] ('''PaaS''') environment for running bots, webservices, scheduled jobs, and doing analysis
* [[Portal:Data_Services|Data Services]] ('''DaaS''') offerings that include a real-time and sanitized production database replica, and NFS access to [[Dumps.wikimedia.org|Wikimedia Dumps]]


==== What is the difference between Cloud VPS and Toolforge? ====
== What Product Should I Use ==


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.
=== [[Portal:Wikimedia_Labs|VPS]] => [[Portal:Wikimedia_Labs|Wikimedia VPS]] ===
If you need to run full virtual instances and are willing to administer them on your own we can provide quota to do so.


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 a [[Help:Toolforge/Grid|distributed job processing system]] as managed services for tool maintainers.
=== [[Portal:Tool_Labs|PaaS]] => [[Portal:Tool_Labs|Toolforge]] ===
If you need to run a specific webservice, scheduled job, or perform analysis but do not want to or are not able to manage a full virtual environment this is the best place.


=== Access databases and data dumps ===
=== [[Portal:Data_Services|DaaS]] => [[Portal:Data_Services| Data Services]] ===
{{anchor|Data Services|reason=Old section name.}}
We provide replicas of the production databases and other data for analysis and experimentation. DaaS resources are available from both the VPS and the PaaS environments, though some of them may need to be requested for a specific VPS Project. In addition, the [https://quarry.wmflabs.org/ Quarry service] provides database access via a web interface without project setup.
{{Note|What is a wiki replica? What's in the dumps? Learn the basics of Wikimedia open data and how to access all available datasets at [[meta:Research:Data|Research:Data]].}}


==== Access wiki databases for tool development====
== Discovery ==


Tools and software hosted on Toolforge and Cloud VPS can directly access public data dumps and production wiki replicas.
* Read our glossary of [[Help:Terminology|terminology]]
* Learn about [[Help:Toolforge/Database | accessing wiki replica databases from a tool account]].
* Browse existing VPS projects using [[toollabs:openstack-browser/|OpenStack Browser]].
* Learn about [[Help:Shared_storage | accessing dumps through shared storage services for Cloud VPS and Toolforge]].
* Project administration is done through the OpenStack dashboard known as [https://horizon.wikimedia.org/ Horizon].
* Toolforge (Tools) has a [[toollabs:|homepage]] and a [[toollabs:?list|directory of Tools]]


== Joining and Participating ==
==== Query wiki replicas and dumps in a browser ====


* '''[[PAWS]]''' provides a Jupyter notebook environment you can use to query wiki replicas and dumps, create interactive graphs, and use APIs for analysis.
[[Help:Terminology|Labs Account Holders]] are governed by the [[Project:Labs Terms of use|Labs terms of use]] and the [[Help:Rules|Rules]]. The [[Mw:Wikimedia Labs/Agreement to disclosure of personally identifiable information|agreement to disclosure of personally identifiable information]] covers [[Help:Terminology|End-Users]].
* '''[[Superset]]''' and '''[https://quarry.wmcloud.org/ Quarry]''' are web interfaces for querying live replica SQL databases of public Wikimedia wikis.
To use Superset or Quarry you need only a Wikimedia login and a web browser, but you should have a basic understanding of SQL. Learn about [[Help:MySQL_queries|SQL queries]].


== Which service is right for you? ==
[[Help:Getting_Started|Getting Started]]


{| class="wikitable"
We are on [[Help:IRC|IRC]]
|+
! rowspan="2" |Activity / Needs
!PAWS
!Superset
!Toolforge
!Cloud VPS
|-
|Data as a service
|Data as a service
|Platform as a service
|Infrastructure as a service
|-
|Write scripts and visualize data
|✔
|
|
|
|-
|Write queries against wiki replica databases
|✔
|✔
|✔
|✔ via Toolforge
|-
|Access on wiki database dump files
|✔
|
|✔
|
|-
|Write and run bots
|✔
|
|✔
|✔ if not viable on Toolforge
|-
|Run web services
|
|
|✔
|✔ if not viable on Toolforge
|-
|Build tools to improve Wikimedia projects
|
|
|✔
|✔ if not viable on Toolforge
|-
|Schedule or run continuous jobs
|
|
|✔
|✔ if not viable on Toolforge
|-
|Need your own subdomain
|
|
|✔
|✔
|-
|Work with co-maintainers and co-admins
|
|
|✔
|✔
|-
|Install packages not provided by Debian or the Wikimedia Foundation
|
|
|
|✔
|-
|Administer your own virtual server
|
|
|
|✔
|-
!Platform / Environment
|web browser
|web browser
|terminal
|terminal
|-
!User knowledge
|curious—advanced
|curious—advanced
|intermediate—advanced
|advanced
|}


== Terms of Use ==
== Before you start ==
* WMCS resources are subject to the [[Wikitech:Labs_Terms_of_use|Wikimedia Labs Terms of Use]].
* Tools must be [[W:Open-source software|open source software]] licensed under an [http://opensource.org/licenses OSI approved license].
* Tools must not collect, store, or share private data or personally identifiable information, such as user names, passwords, or IP addresses, except when complying with the conditions listed in the [[Wikitech:Labs_Terms_of_use|Wikimedia Labs Terms of Use]].


To use Cloud Services products, you must first [[Help:Create a Wikimedia developer account|create a Wikimedia account and a developer account]].
== Media ==


== Learn more ==
* [[File:WMCS_Presentation.pdf|What is Wikimedia Cloud Service?]]

* 🎬 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)

{{:Help:Cloud Services communication}}

[[Category:Overviews]]
[[Category:Cloud Services]]

Revision as of 21:35, 3 February 2024

A Poster showing some Wikimedia Cloud services statistics and services
Poster-format 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.

What can you do with Cloud Services?

Host tools on Wikimedia servers

Tools and bots make it easier to edit and maintain Wikimedia projects. For developers who support Wikimedia projects by developing tools and bots, Toolforge provides the following features:

  • Free, reliable, and scalable shared hosting, including web servers, databases and other data storage
  • A distributed job processing system
  • Support for multiple users to collaboratively maintain and manage tools

To use Toolforge you need:

  • Some programming knowledge
  • An understanding of Unix command line

To get started, visit Help:Toolforge. Or, learn more about creating bots.

Run scripts and visualize data

PAWS is a Jupyter notebook installation hosted by Wikimedia. PAWS notebooks can be used for creating tutorials, running live code, creating data visualizations, running basic bots, and more.

A single PAWS notebook is maintained by a single user, but they can be downloaded and forked by other users. To use PAWS you need only a Wikimedia login and a web browser. Knowledge of Python is helpful, but not required.

Administer servers for software development

Open source software projects help the Wikimedia movement by improving core infrastructure (like MediaWiki), powering research and analytics, and supporting Wikimedia operations and software development. For advanced projects that aren't viable in the Toolforge environment, Cloud VPS (Virtual Private Server) provides the following features:

  • Free cloud computing environment, powered by OpenStack
  • Collaboratively-owned collections of virtual private servers, storage, firewall, and HTTPS proxy resources to projects
  • Access to a variety of data services
  • Freedom to install packages not provided by Debian or the Wikimedia Foundation

To use Cloud VPS, you need:

  • An open source project that isn't viable in the Toolforge environment, or can't be accomplished using other WMCS offerings
  • One or more active project maintainers who meet basic requirements
  • Advanced programming knowledge
  • Advanced experience with Unix command line
  • The ability to administer your own servers and manage your project's applications, data, runtime, middleware, and operating systems

To get started, visit Help:Cloud VPS.

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 a distributed job processing system as managed services for tool maintainers.

Access databases and data dumps

What is a wiki replica? What's in the dumps? Learn the basics of Wikimedia open data and how to access all available datasets at Research:Data.

Access wiki databases for tool development

Tools and software hosted on Toolforge and Cloud VPS can directly access public data dumps and production wiki replicas.

Query wiki replicas and dumps in a browser

  • PAWS provides a Jupyter notebook environment you can use to query wiki replicas and dumps, create interactive graphs, and use APIs for analysis.
  • Superset and Quarry are web interfaces for querying live replica SQL databases of public Wikimedia wikis.

To use Superset or Quarry you need only a Wikimedia login and a web browser, but you should have a basic understanding of SQL. Learn about SQL queries.

Which service is right for you?

Activity / Needs PAWS Superset Toolforge Cloud VPS
Data as a service Data as a service Platform as a service Infrastructure as a service
Write scripts and visualize data ✔
Write queries against wiki replica databases ✔ ✔ ✔ ✔ via Toolforge
Access on wiki database dump files ✔ ✔
Write and run bots ✔ ✔ ✔ if not viable on Toolforge
Run web services ✔ ✔ if not viable on Toolforge
Build tools to improve Wikimedia projects ✔ ✔ if not viable on Toolforge
Schedule or run continuous jobs ✔ ✔ if not viable on Toolforge
Need your own subdomain ✔ ✔
Work with co-maintainers and co-admins ✔ ✔
Install packages not provided by Debian or the Wikimedia Foundation ✔
Administer your own virtual server ✔
Platform / Environment web browser web browser terminal terminal
User knowledge curious—advanced curious—advanced intermediate—advanced advanced

Before you start

To use Cloud Services products, you must first create a Wikimedia account and a developer account.

Learn more

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
Stay aware of critical changes and plans
Track work tasks and report bugs

Use a subproject of the #Cloud-Services Phabricator project to track confirmed bug reports and feature requests about the Cloud Services infrastructure itself

Read stories and WMCS blog posts

Read the Cloud Services Blog (for the broader Wikimedia movement, see the Wikimedia Technical Blog)

Retrieved from "https://wikitech.wikimedia.org/w/index.php?title=Help:Cloud_Services_introduction&oldid=2145397"