ReleaseEngineering/Applications/Mapper: Difference between revisions

← Older edit

ReleaseEngineering/Applications/Mapper (view source)

Revision as of 01:54, 30 June 2018

1,507 bytes added , 30 June 2018

new mapper url

Garbas

14

edits

@@ Line 1: / Line 1: @@
 = What is it? =
-mapper is a web application that converts hg revisions to a git revision using the hggit map files created as part of the repository conversion.
+When we convert hg repositories to git, and vice versa, the hg changeset SHA (the 40 character hexadecimal string that you get when you commit a change) is different to the git commit id (the equivalent SHA used by git).
-= Source =
+In order to keep track of which hg changeset SHAs relate to which git commit SHAs, we keep a database of the mappings, together with details about the project the SHAs come from, and what time they were inserted into the database.
-mapper's source is currently hosted at https://github.com/catlee/mapper
-= Deployment =
+The vcs sync tool (checked into mozharness) is the tool which performs the conversion between hg repos and git repos, and this is documented separately. It is responsible for performing the conversion - this is outside the scope of mapper.
-mapper only requires bottle to run. It's recommended to run inside a virtual environment
-Our current production deployment of mapper lives on cruncher under /home/buildduty/mapper. It listens locally on port 8888 (specified in mapper/app.py). The apache instance on cruncher is configured to forward requests to http://cruncher/mapper/* to http://locahost:8888/* (configured in /etc/httpd/conf/httpd.conf)
+Mapper is a rest api, that allows:
+# insertion of new mappings and projects (a "project" is essentially the name of the repo - e.g. build-tools) (HTTP POST)
+# insertion of git/hg mappings for a given project (HTTP POST)
+# retrieval of mappings for a given project (HTTP GET)
-The mapper process is managed by supervisord which will ensure it is started up if the machine is ever rebooted, or if the process crashes. (configured in /etc/supervisord.conf)
+Behind the scenes, it is reading/writing from the database (using sqlalchemy).
-= Mapper Data Source =
+Note: the vcs sync tool is a client of the mapper: it is vcs sync that inserts into mapper (i.e. uses the HTTP POST methods).
+The other clients of mapper will be:
+# people / developers - wanting to query mappings
+# b2g_build.py - the build script for b2g - since this needs to lookup shas in order to reference frozen commit versions in manifests
-This section describes (roughly) how vcs-sync provides the map files served by mapper.
+Mapper is written as a RelEng API blueprint - please note RelEng API has its [https://docs.mozilla-releng.net/projects/releng-mapper.html own documentation] too.
-The map files are generated and combined on the vcs-sync machines, then pulled onto cruncher and used by `mapper`. See the [http://hg.mozilla.org/users/hwine_mozilla.com/repo-sync-tools/ source] and [http://people.mozilla.com/~hwine/tmp/vcs2vcs/ docs] for vcs-sync for more details. (Especially the [http://people.mozilla.com/~hwine/tmp/vcs2vcs/mapper_support.html mapper support] section.)
-mapper expects hggit map files to be available under the 'mapfiles' directory of the application. On cruncher, these are in /home/buildduty/mapper/mapfiles. Each subdirectory of mapfiles corresponds loosely to a different repository being tracked. On cruncher, the mapfiles for each of these projects are symlinked to the mapfiles being published to cruncher via the process outlined above.
+= Mapper Development & Deployment =
-''Note that the above docs will be integrated into the wiki after vcs-sync development stabilizes.''
+The mapper is a project in [https://github.com/mozilla-releng/services mozilla-releng/services] repository, and so the details about how to deploy locally for development, and where the staging/production environments are, can be seen in the [https://docs.mozilla-releng.net/ RelEngAPI documentation].
+= Mapper Data Feed =
+VCS Sync is making HTTP Post requests to mapper, providing new mappings for mapper to insert into its database.
+= API methods =
+Below is a summary of the 4 unauthenticated API methods currently usable, together with example urls from the production environment.
+For fuller details, and endpoints requiring authentication, the in process documentation is authoritative: [https://mapper.mozilla-releng.net/docs production] or [https://mapper.staging.mozilla-releng.net/docs staging] instances.
+== GET Routes ==
+=== Returns a mapping pair ===
+* GET:  /<project>/rev/<vcs_type>/<commit>
+* Example: https://mapper.mozilla-releng.net/build-puppet/rev/git/69d64a8a18e6e001eb015646a82bcdaba0e78a24
+* Example: https://mapper.mozilla-releng.net/build-puppet/rev/hg/68f1b2b9996c4e33aa57771b3478932c9fb7e161
+=== Returns full mapfile for a given project ===
+* GET:  /<project>/mapfile/full
+* Example: https://mapper.mozilla-releng.net/build-puppet/mapfile/full
+=== Returns a subset of a mapfile, since a given date ===
+* GET:  /<project>/mapfile/since/<since>
+* Example: https://mapper.mozilla-releng.net/build-mozharness/mapfile/since/29.05.2014%2017:02:09%20CEST
+=== Returns list of projects ===
+* GET:  /projects
+* Example: https://mapper.mozilla-releng.net/projects
+= Staging =
+The staging environment is available under https://mapper.staging.mozilla-releng.net (Look under "Documentation" to find details.)