Difference between revisions of "Help:Cloud Services Introduction"

From Wikitech-static
Jump to navigation Jump to search
imported>BryanDavis
(interwiki links, some wording tweaks)
imported>Aklapper
(remove "from Wikimedia Hackathon" details that I don't care about; add year to know how recent those external docs are)
 
(40 intermediate revisions by 19 users not shown)
Line 1: Line 1:
Welcome to Wikimedia Cloud Services (WMCS)!
{{notice | wmflabs.org and wmcloud.org redirect here. You might be looking for the [[:Category:Toolforge tools|Lists of Toolforge tools]] or the [[toolforge:openstack-browser/project/|List of Cloud VPS projects]].}}


WMCS is a flexible computing ecosystem built on [[W:OpenStack|OpenStack]], [[W:Oracle Grid Engine|GridEngine]], and [[W:Kubernetes|Kubernetes]].  We empower technical contribution to the Wikimedia software world.
[[File:What is Cloud Services? poster.pdf|thumb|upright=1.3|Poster-format overview]]


Support and administration of the WMCS resources is provided by a [[Mw:Wikimedia Cloud Services team|Wikimedia Foundation team]] and Wikimedia movement volunteers.
== WMCS project overview ==


== History ==
===What is Wikimedia Cloud Services (WMCS)?===
''Eventual final branding and renaming is open for [[User:BryanDavis/Rebranding Cloud Services products|discussion]].''


  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.
'''Wikimedia Cloud Services''' ('''WMCS''') provides tools, services, and support for technical collaborators who want to contribute to Wikimedia software projects. WMCS is a computing ecosystem built on [[W:OpenStack|OpenStack]], [[W:Oracle Grid Engine|GridEngine]], and [[W:Kubernetes|Kubernetes]].  


----------
WMCS products and services are available for use by anyone connected with the [[meta:Wikimedia movement|Wikimedia movement]] without charge. Support and administration of the WMCS resources is provided by a [[Mw:Wikimedia Cloud Services team|Wikimedia Foundation Cloud Services team]] and [[wmf:Volunteer_opportunities|Wikimedia movement volunteers]]. We maintain a [[Help:Glossary|Glossary]] of related terminology.


From 2011 until early 2017, WMCS was known as "Wikimedia Labs". 
🎬 '''Video''': [https://media.ccc.de/v/36c3-77-wikimedia-cloud-services-introduction Wikimedia Cloud Services introduction] (2019)


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.
📣 '''Slides''': [[commons:File:Introduction_to_Wikimedia_Cloud_Services_-_Wikimania_Hackathon_2019_Stockholm_Sweden.pdf|An introduction to Cloud Services presentation]] (2019)


== WMCS Products ==
=== WMCS history ===
* [[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 Product Should I Use ==
From 2011 until early 2017, WMCS was known as "Wikimedia Labs." The term 'Labs' was used to refer to a number of different [[Labs labs labs|components]], and clarification was required. In 2017, the project was reorganized. The former Wikimedia Foundation Labs team and the Tool Labs Support team joined together to create the Wikimedia Cloud Services team.


=== [[Portal:Wikimedia_Labs|VPS]] => [[Portal:Wikimedia_Labs|Wikimedia VPS]] ===
{{anchor|WMCS Products}}
If you need to run full virtual instances and are willing to administer them on your own we can provide quota to do so. 


=== [[Portal:Tool_Labs| PaaS]] => [[Portal:Tool_Labs|ToolForge]] ===
== WMCS products and services ==
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.


=== [[Portal:Data_as_a_Service|DaaS]] => [[Portal:Data_Services| Data Services]] ===
{{anchor|What product should I use?}}
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.
{| class="wikitable sortable"
|+ WMCS Products
! Service
! Product
! Description
! Use
! Support Level
|-
| [[:en:Virtual_private_server|VPS]]
| [[Portal:Cloud VPS|Cloud VPS]]
| Provides collaboratively owned collections of virtual private servers where users develop and maintain software projects that help the Wikimedia movement.
| Use this to run full virtual instances.
| You are willing to administer instances on your own. We can provide quota to do so.  
|-
| [[:en:Platform as a service|PaaS]]
| [[Portal:Toolforge|Toolforge]]
| Provides a shared hosting/platform-as-a-service environment for running bots, webservices, scheduled jobs, and data analysis.
| Run a specific webservice, scheduled job, or perform analysis.
| You do not want to or are not able to manage a full virtual environment.
|-
| [[:en:Data_as_a_service|DaaS]]
| [[Portal:Data Services|Data Services]]
| A collection of products including private-information-redacted copies of Wikimedia's production wiki databases and access to [[Dumps.wikimedia.org|Wikimedia Dumps]].
| Create replicas of the production databases and other data for analysis and experimentation.  
| The [[quarry:|Quarry service]] provides database access via a web interface. Some DaaS resources may need to be requested for specific VPS projects.
|}


== Discovery ==
=== Renaming of products and services ===
We are in the process of changing the [[phab:phame/post/view/59/labs_and_tool_labs_being_renamed/| language and branding]] of the products and services we offer. You may find some outdated titles and names in WMCS documentation. Edits are welcome!


* [[Help:Terminology|Terminology]]
== Participating with WMCS ==


* WMCS is working on a tool for read-only browsing of our projects at [[Toollabs:openstack-browser/|OpenStack Browser]].
=== Sign up for services ===


* Project administration is done through the OpenStack dashboard known as [https://horizon.wikimedia.org/auth/login/?next=/ Horizon].
To access and contribute to Cloud Services projects and tools, you will need the following accounts:


* ToolForge (Tools) has a [http://tools.wmflabs.org/ homepage] and a [http://tools.wmflabs.org/?list directory of Tools]
*'''Wikimedia account''' - this account is the single user login or SUL account you use to contribute to Wikipedia and its sister projects.
*[[Help:Create_a_Wikimedia_developer_account|'''Wikimedia developer account''']] - this account is used log into this wiki, Toolforge, Cloud VPS, Gerrit and other protected Wikimedia Services.
* '''[[mw:Gerrit|Gerrit]]''' - our code review system; where our repositories (repos) live. Note that while [[mw:Gerrit/GitHub|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.
* '''[[mw:Phabricator|Phabricator]]''' - our project management system; for opening tickets, suggesting features, and talking about our plans for the next quarter.
* '''[[mw:MediaWiki on IRC|IRC]]''' - live chat channels. We have several channels related to our cloud servers, but the main channel is {{IRC|wikimedia-cloud}}. Deployment also frequently uses {{IRC|wikimedia-serviceops}}.
* The ability to [[Help:Access|access instances]] in the WMCS environment.


== Joining and Participating ==
===Review the terms and conditions===


[[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]].
Second, make sure to review and agree to our terms and conditions. [[Help:Terminology|Account holders]] who plan to use WMCS resources and products must read and agree to the following:


[[Help:Getting_Started|Getting Started]]
* [[Wikitech:Cloud Services Terms of use|Wikimedia Cloud Services Terms of Use]]
* [[mw:Code of Conduct|Code of Conduct for technical spaces]]
* [[mw:Wikimedia Labs/Agreement to disclosure of personally identifiable information|Agreement to disclosure of personally identifiable information]] (covers [[Help:Terminology|End-Users]]).


We are on [[Help:IRC|IRC]]
Please pay close attention to the following terms for '''Toolforge and Cloud VPS:'''


== Terms of Use ==
* Toolforge tools must be [[w:Open-source software|open source software]] licensed under an [http://opensource.org/licenses OSI approved license].
* WMCS resources are subject to the [[Wikitech:Labs_Terms_of_use|Wikimedia Labs Terms of Use]].
* Toolforge and Cloud VPS projects 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:Cloud Services Terms of use|Wikimedia Cloud Services 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]].


== Media ==
{{:Help:Cloud Services communication}}


* [[File:WMCS_Presentation.pdf|What is Wikimedia Cloud Service?]]
== Learn more ==
 
* [[Help:FAQ | Cloud VPS and Toolforge At-A-Glance]]: This page provides a basic introduction to '''Cloud VPS''' and '''Toolforge'''.
* [[Portal:Cloud_VPS | Cloud VPS Portal]]: Information about Cloud VPS and links to help and technical documentation.
* [[Portal:Toolforge | Toolforge Portal]]: Information about Toolforge and links to help and technical documentation.
* [[Portal:Data_Services | Data Services Portal]]: Information about Data Services and links to help and technical documentation.
 
[[Category:Cloud Services]]

Latest revision as of 16:48, 18 October 2021

Poster-format overview

WMCS project overview

What is Wikimedia Cloud Services (WMCS)?

Wikimedia Cloud Services (WMCS) provides tools, services, and support for technical collaborators who want to contribute to Wikimedia software projects. WMCS is a computing ecosystem built on OpenStack, GridEngine, and Kubernetes.

WMCS products and services are available for use by anyone connected with the Wikimedia movement without charge. Support and administration of the WMCS resources is provided by a Wikimedia Foundation Cloud Services team and Wikimedia movement volunteers. We maintain a Glossary of related terminology.

🎬 Video: Wikimedia Cloud Services introduction (2019)

📣 Slides: An introduction to Cloud Services presentation (2019)

WMCS history

From 2011 until early 2017, WMCS was known as "Wikimedia Labs." The term 'Labs' was used to refer to a number of different components, and clarification was required. In 2017, the project was reorganized. The former Wikimedia Foundation Labs team and the Tool Labs Support team joined together to create the Wikimedia Cloud Services team.

WMCS products and services

WMCS Products
Service Product Description Use Support Level
VPS Cloud VPS Provides collaboratively owned collections of virtual private servers where users develop and maintain software projects that help the Wikimedia movement. Use this to run full virtual instances. You are willing to administer instances on your own. We can provide quota to do so.  
PaaS Toolforge Provides a shared hosting/platform-as-a-service environment for running bots, webservices, scheduled jobs, and data analysis. Run a specific webservice, scheduled job, or perform analysis. You do not want to or are not able to manage a full virtual environment.
DaaS Data Services A collection of products including private-information-redacted copies of Wikimedia's production wiki databases and access to Wikimedia Dumps. Create replicas of the production databases and other data for analysis and experimentation.   The Quarry service provides database access via a web interface. Some DaaS resources may need to be requested for specific VPS projects.

Renaming of products and services

We are in the process of changing the language and branding of the products and services we offer. You may find some outdated titles and names in WMCS documentation. Edits are welcome!

Participating with WMCS

Sign up for services

To access and contribute to Cloud Services projects and tools, you will need the following accounts:

  • Wikimedia account - this account is the single user login or SUL account you use to contribute to Wikipedia and its sister projects.
  • Wikimedia developer account - this account is used log into this wiki, Toolforge, Cloud VPS, Gerrit and other protected Wikimedia Services.
  • Gerrit - our code review system; where our repositories (repos) live. 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.
  • Phabricator - our project management system; for opening tickets, suggesting features, and talking about our plans for the next quarter.
  • IRC - live chat channels. We have several channels related to our cloud servers, but the main channel is #wikimedia-cloud connect. Deployment also frequently uses #wikimedia-serviceops connect.
  • The ability to access instances in the WMCS environment.

Review the terms and conditions

Second, 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:

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
Connect Best for
Phabricator Workboard #Cloud-Services Task tracking and bug reporting
IRC Channel #wikimedia-cloud connect
Telegram bridge
mattermost bridge
General discussion and support
Mailing List cloud@ Information about ongoing initiatives, general discussion and support
Announcement emails cloud-announce@ Information about critical changes (all messages mirrored to cloud@)
News wiki page News Information about major near-term plans
Cloud Services Blog Clouds & Unicorns Learning more details about some of our work
Wikimedia Technical Blog techblog.wikimedia.org News and stories from the Wikimedia technical movement

Learn more