Analytics/Onboarding

From Wikitech

Background

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. Please update this document as you go along! Last but not the least, the most important thing: welcome to the Analytics team!

First Steps

This section is related to the first logistic steps to effectively join the Wikimedia's staff crew. Take your time to explore and look around, don't rush!

Wikimedia tech employee orientation

Starting point for each new Wikimedia employee: https://office.wikimedia.org/wiki/New_tech_employee_orientation

Wikimedia account

Your manager and the Wikimedia's IT department will help you open several accounts including your work email. Right after this step, you will be able to communicate and participate to the day to day discussions between staff members. Be patient and don't be scared about the huge amount of information and emails that you'll receive!

E-mail lists

Reading mailing lists is important. All projects we build or use are open-source, and as most open-source projects, they have communities which come together on mailing lists. There is much knowledge to be gained in these mailing lists.

Once you have a Wikimedia e-mail address you should subscribe yourself to these e-mail lists:

For an overview of all available mailing lists see https://lists.wikimedia.org/mailman/listinfo

  • Optionally you may want to read archives or subscribe to the following mailing lists:
  1. Mediawiki
  2. Mobile
  3. Mediawiki API

If there are mailing lists you want to read without subscribing you may consider using the following gateways:

  1. Mail Archive
  2. Gmane
  3. Gossamer Threads

IRC

Most of our communication happens on IRC, you should set up an IRC nick

  1. Install an IRC client -- ask team members for recommendations ( some would be quassel, irssi, pidgin, xchat, textual or adium if you're on a Mac )
  2. Follow instructions on https://meta.wikimedia.org/wiki/IRC/Cloaks to request an IRC cloack
  3. Connect to #wikimedia-analytics on Freenode
  4. 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

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 permit

Please follow the next subsections (order matters!) to get permissions for various fundamental services. Access to Production will be covered in a separate section.

Wikitech/Labs

Labs is a cluster of virtual machines. Access is completely decouple from production and different ssh keys should be used.

Labs is not production but we have several tools hosted on the cluster, accessing to labs requires a wikitech account:

  1. Create account
  2. Request Shell Access
  3. Log in
  4. You need to set up ssh keys
  5. Upload your public SSH key. 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 (see section below about Production access).
  6. Configure your ~/.ssh/config with bastion hosts
  7. 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. Follow this page to log in for the first time (please use the sunflower icon as suggested by the tutorial to leverage the single sign on).

Mediawiki

  1. Create an account
  2. Log in

Gerrit

  1. Gerrit is the code review workflow we use, build on top of git
  2. Log in to Gerrit using your Wikitech/Labs credentials.
  3. To verify everything works, clone a repo repo from https://gerrit.wikimedia.org/r/#/admin/projects/?filter=analytics using SSH.
  4. Take a look at how to deal with gerrit in different work scenarios: http://etherpad.wikimedia.org/p/analytics-gerrit

Accessing production infrastructure

With great power comes great responsibility. Please do read carefully the Wikimedia's SSH access guidelines and familiarize with your new SSH config before proceeding. Moreover we manage very sensitive data, please read Analytics/Data access to familiarize yourself with our procedures.

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 (example: https://phabricator.wikimedia.org/T96053).

Talk with Andrew Otto about how to submit your ssh public 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: 

### 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

Logging in

Once you have your SSH setup in place and your credentials have been approved by Ops (using the Phabricator task created before) you will be able to explore the Analytic infrastructure. Please start from Analytics and check the instruction for projects, for example:

Talk with the people of your team on IRC about their work and pointers to their projects, so you will get a more precise idea about who does what. Be patient, it will take a while to get a good overall picture!

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:

Operating System

The machines we deploy on are using Ubuntu and it would be more convenient for you to have Ubuntu installed on your development machine or any other UNIX based operating system. It will considerably facilitate your work. You may choose 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:

  1. sshfs
  2. rsync
  3. lsync
  4. unison
  5. scp

IDEs and editors

For Java development, you may use what IDE you feel comfortable with. Eclipse is the IDE du jour, but you might want to look at IDEA also. For remote development you may find vim to be useful(or a combination of a sync tool and your favorite editor/IDE). Other editors you might find useful may include Sublime Text, Emacs.

Searching

You may find the following tools useful to search through configuration files or code:

  1. Ack (mainly for grepping code. video presentation)
  2. grep
  3. GNU find

Environment simulation

It may be useful that you familiarize yourself with Vagrant and 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:

Retrieved from "https://labtestwikitech.wikimedia.org/w/index.php?title=Analytics/Onboarding&oldid=14590"