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

Analytics/Onboarding: Difference between revisions

From Wikitech-static
Jump to navigation Jump to search
imported>Milimetric
imported>Nintendofan885
m (Resolving double redirect)
 
(9 intermediate revisions by 6 users not shown)
Line 1: Line 1:
=Background=
#REDIRECT [[Data Engineering/Team/Onboarding]]
You will need lots of accounts, memberships and other secret keys to become a real productive member of the Analytics team. Here's an overview of things you should do in the first week. <b>Please update this document as you go along </b>
 
 
= First Things =
==e-mail list==
Once you have a wikimedia e-mail address you should subscribe yourself to two e-mail lists:
analytics-internal@
analytics@
 
Link:
https://lists.wikimedia.org/mailman/listinfo/analytics
 
https://lists.wikimedia.org/mailman/listinfo/analytics-internal
 
Archives:
 
https://lists.wikimedia.org/pipermail/analytics/
https://lists.wikimedia.org/mailman/private/analytics-internal/
 
==IRC==
Most of our communication happens on IRC, you should set up an IRC nick
# Install an IRC client -- ask team members for recommendations ( some would be [http://quassel-irc.org/ quassel], [http://irssi.org/ irssi], [http://www.pidgin.im/ pidgin], [http://xchat.org/ xchat], [http://www.codeux.com/textual/ textual] or [https://adium.im/ adium] if you're on a Mac )
# Follow instructions on [https://meta.wikimedia.org/wiki/IRC/Cloaks https://meta.wikimedia.org/wiki/IRC/Cloaks] to request an IRC cloack
# Connect to #wikimedia-analytics on Freenode
# Other channels you might be interested in:
#wikimedia-labs, #wikimedia-operations, #wikimedia-office
 
==Office wiki ==
Make sure you  have an employee account and that you can use the office wiki, your office wiki user will be given to you once
you get your wikimedia e-mail address.
 
https://office.wikimedia.org/wiki/Getting_Started_With_User_Info_and_Talk_Pages
 
==Headset==
Please buy a high-quality headset -- your colleagues will love you for this. For more tips see [https://office.wikimedia.org/wiki/Office_IT/Projects/Telepresence https://office.wikimedia.org/wiki/Office_IT/Projects/Telepresence]
 
==Culture==
We are part of a movement with a unique culture.  It's worth taking the time to read a bit about how our biggest project works.  This policy could be a useful start, as it introduces the core concepts from a concrete point of view: https://en.wikipedia.org/wiki/Wikipedia:Biographies_of_living_persons
 
=Getting permits=
Sample ticket asking for permits: https://phabricator.wikimedia.org/T96053
* The very first thing to do will be to get a labs account and a phabricator account so you can file tickets for anything else you need.
* Labs is a cluster of virtual machines. Access is completely decouple from production and different ssh keys should be used.
 
==Labs==
Labs is not production but we have several tools hosted on the cluster, accessing to labs requires a wikitech account (I know, confusing)
# Create account: [https://wikitech.wikimedia.org/w/index.php?title=Special:UserLogin&type=signup&returnto=Main+Page https://wikitech.wikimedia.org/w/index.php?title=Special:UserLogin&type=signup&returnto=Main+Page]
# Request Shell Access: https://wikitech.wikimedia.org/wiki/Help:Access
# Log in
# You need to set up ssh keys: [[https://wikitech.wikimedia.org/wiki/Help:Access#Prerequisites]]
# Upload your public SSH key: [https://wikitech.wikimedia.org/wiki/Special:Preferences#mw-prefsection-openstack https://wikitech.wikimedia.org/wiki/Special:Preferences#mw-prefsection-openstack]
## Please have in mind that labs is a testing environment thus this ssh key should only be used in testing, if you need access to machines in the production cluster your ssh key should be different.
# Configure your '''~/.ssh/config''' with bastion hosts
# Get familiar with the labs environment, how to use the labs interface to spin up nodes, remove nodes, etc
 
== Phabricator ==
https://phabricator.wikimedia.org is the version of phabricator that we use.You can browse tasks but to create/edit you need access to LDAP.
 
 
==Mediawiki==
# Create account: [https://www.mediawiki.org/w/index.php?title=Special:UserLogin&returnto=Analytics&type=signup https://www.mediawiki.org/w/index.php?title=Special:UserLogin&returnto=Analytics&type=signup]
# Log in
 
==Gerrit==
# Gerrit is the code review workflow we use, build on top of git
# Log in to [https://gerrit.wikimedia.org/r/#/ Gerrit] using your Labs credentials.
# To verify everything works, clone a repo repo from [https://gerrit.wikimedia.org/r/#/admin/projects/?filter=analytic https://gerrit.wikimedia.org/r/#/admin/projects/?filter=analytics] using SSH.
# Take a look at how to deal with gerrit in different work scenarios: http://etherpad.wikimedia.org/p/analytics-gerrit
 
==Mailinglists==
 
Reading mailing lists is important. All projects we build or use are opensource, and as most opensource projects, they have communities which come together on mailing lists. There is much knowledge to be gained in these mailing lists.
 
* Please subscribe to:
# [https://lists.wikimedia.org/mailman/listinfo/analytics https://lists.wikimedia.org/mailman/listinfo/analytics]
# [https://lists.wikimedia.org/mailman/listinfo/wikimetrics https://lists.wikimedia.org/mailman/listinfo/wikimetrics]
# [https://lists.wikimedia.org/mailman/listinfo/wmfresearch https://lists.wikimedia.org/mailman/listinfo/wmfresearch]
* Please request acces to:
# Analytics internal (email Toby)
# Operations
# Engineering  
For an overview of all available mailinglists see [https://lists.wikimedia.org/mailman/listinfo https://lists.wikimedia.org/mailman/listinfo]
 
* Optionally you may want to read archives or subscribe to the following mailing lists:
# [https://lists.wikimedia.org/mailman/listinfo/mediawiki-l/ Mediawiki]
# [https://lists.wikimedia.org/mailman/listinfo/mobile-l/ Mobile]
# [https://lists.wikimedia.org/mailman/listinfo/mediawiki-api/ Mediawiki API]
 
If there are mailing lists you want to read without subscribing you may consider using the following gateways:
# [http://www.mail-archive.com/find.php?q=wikimedia&sa=Search&lists=all Mail Archive]
# [http://news.gmane.org/index.php?prefix=gmane.org.wikimedia Gmane]
# [http://www.gossamer-threads.com/lists/wiki/ Gossamer Threads]
 
 
= Accessing production infrastructure=
 
== Servers ==
All Analytics team-members should have access requested to the following machines:
* stat1001
* stat1002
* stat1003?
* bast1001.wikimedia.org
* bastion.wmflabs.org
* Hadoop cluster
* vanadium/hafnium
* Eventlogging DB through 1003, which means you are in analytics research group
 
== Shell access to wikimedia cluster and production infrastructure==
# Tickets are filed for the ops team to see and need to be approved by a manger: [https://wikitech.wikimedia.org/wiki/Requesting_shell_access]
 
Talk with [[User:Aotto|Andrew Otto]] about how to submit your private key. You would likely need to proxy your ssh connection from a know machine to access
 
some of the hosts above.  You should not use the same ssh key for labs (testing) and stat1 machines (production).
 
The easiest would be to ask some team member for its .ssh/config file and get the proxy setup.
 
Please have in mind that different processes are required to access production machines (stat1) and testing machines (labs)
 
== Sample ssh config ==
Sample ssh config:
 
<syntaxhighlight lang="powershell">
### Short names
Host <some host you want your system to auto-complete>
 
## Use bastion-eqiad.wmflabs.org as proxy to labs
Host bastlabs
HostName bastion-eqiad.wmflabs.org
User <your-username>
 
Host *.eqiad.wmflabs !bastion-eqiad.wmflabs.org
User <your-username>
IdentityFile ~/.ssh/id_rsa
ProxyCommand ssh -a -W %h:%p bastlabs
 
## Prod
Host bastprod
HostName bast1001.wikimedia.org
User <your-username>
 
Host *.eqiad.wmnet *.wikimedia.org !bast1001.wikimedia.org
User <your-username>
IdentityFile ~/.ssh/id_rsa_prod
ProxyCommand ssh -a -W %h:%p bastprod
</syntaxhighlight>
 
 
= Process =
==Google Calendar==
# Add the Analytics Team Calendar to your default view.  Someone (we all can manage sharing) should go to https://calendar.google.org and add you:
#* My Calendars -> Settings
#* Click Team Analytics -> Share This Calendar
#* Add the new person
 
== Scrum ==
[[Analytics/Scrum_Planning]]
 
 
=Equipment=
 
==Hardware==
As far as equipment goes you will need a good development machine.
 
Minimum machine specs:
 
* >=4GB RAM
* i7 >= 2.4 Ghz quad-core or better
* 300GB disk
 
Recommended machine specs:
 
* >=8GB RAM
* i7 >= 2.4 Ghz quad-core or better
* SSD (if you're going to be working on wikimetrics)
* 300GB disk
 
At first sight you might think these are not required, but you will have to run VMs, you will be using vagrant
to re-create various environments(sometimes with multiple nodes), so you will need some hardware for that.
 
 
=Optional accounts=
 
You could consider creating accounts for:
* [https://github.com GitHub]
 
=Operating System=
 
The machines we deploy on are using Ubuntu and it would be more convenient for you to have
[http://www.ubuntu.com/download/desktop Ubuntu] installed on your development machine or any other UNIX based operating system.
It will considerably facilitate your work.
You may choose [http://distrowatch.com/ any other Linux distribution] you're familiar with.
 
Mac is also a very possible choice.
 
=Misc=
 
This is a collection of things you might find useful in your work.
 
==Sync tools==
 
You may find the following tools useful for sync-ing files between your local machine and remote machines(one-way or two-way). You can also mount remote directories as if they were your local directories:
 
# '''[http://fuse.sourceforge.net/sshfs.html sshfs]'''
# '''[http://linux.die.net/man/1/rsync rsync]'''
# [http://code.google.com/p/lsyncd/ lsync]
# [http://www.cis.upenn.edu/~bcpierce/unison/ unison]
# '''[http://linux.die.net/man/1/scp scp]'''
 
==IDEs and editors==
 
For Java development, you may use what IDE you feel comfortable with. [http://www.eclipse.org/kepler/ Eclipse] is the IDE du jour, but you might want to look at [http://www.jetbrains.com/idea/ IDEA] also.
For remote development you may find [http://www.vim.org/ vim] to be useful(or a combination of a sync tool and your favorite editor/IDE).
Other editors you might find useful may include [http://www.sublimetext.com/2 Sublime Text], [http://www.gnu.org/software/emacs/ Emacs].
 
==Searching==
 
You may find the following tools useful to search through configuration files or code:
 
# [http://beyondgrep.com/ Ack] (mainly for grepping code. [http://www.youtube.com/watch?v=sKmyl5D8Da8 video presentation])
# [http://www.gnu.org/software/grep/manual/grep.html grep]
# [http://www.gnu.org/software/findutils/manual/html_mono/find.html GNU find]
 
[[Category:Wikimedia Foundation teams internals]]
 
==Environment simulation==
 
It may be useful that you familiarize yourself with [http://www.vagrantup.com/ Vagrant] and [http://docs.puppetlabs.com/learning/ Puppet] to be able to recreate smaller environments/conditions on your machine to test various software you're developing or contributing to.
 
== Important Talks ==
Talks recommended by other members of the Analytics team:
* [https://www.youtube.com/watch?v=-We4GZbH3Iw&feature=youtu.be&t=33m51s The Paramecium Talk], Aaron Halfaker
 
== Random Docs ==
Thorough description of our Hadoop infrastructure : https://plus.google.com/u/0/events/c53ho5esd0luccd09a1c30rlrmg

Latest revision as of 11:05, 30 November 2021

Redirect to:

Retrieved from "https://wikitech-static.wikimedia.org/w/index.php?title=Analytics/Onboarding&oldid=585115"