doc/user/tutorials/add-new-repository.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: Adding a new Arvados git repository
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 Arvados repositories are managed through the Git revision control system. You can use these repositories to store your crunch scripts and run them in the arvados cluster.
  13
  14 {% include 'tutorial_expectations' %}
  15
  16 h2. Setting up Git
  17
  18 Before you start using Git and arvados repositories, you should do some basic configuration (you only need to do this the first time):
  19
  20 <notextile>
  21 <pre><code>~$ <span class="userinput">git config --global user.name "Your Name"</span>
  22 ~$ <span class="userinput">git config --global user.email $USER@example.com</span></code></pre>
  23 </notextile>
  24
  25 h2. Add "tutorial" repository
  26
  27 On the Arvados Workbench, click on the dropdown menu icon <span class="fa fa-lg fa-user"></span> <span class="caret"></span> in the upper right corner of the top navigation menu to access the user settings menu, and click on the menu item *Repositories*.
  28
  29 In the *Repositories* page, you will see the *Add new repository* button.
  30
  31 !{display: block;margin-left: 25px;margin-right: auto;}{{ site.baseurl }}/images/repositories-panel.png!
  32
  33 Click the *Add new Repository* button to open the popup to add a new arvados repository. You will see a text box where you can enter the name of the repository. Enter *tutorial* in this text box and click on *Create*.
  34
  35 {% include 'notebox_begin' %}
  36 The name you enter here must begin with a letter and can only contain alphanumeric characters.
  37 {% include 'notebox_end' %}
  38
  39 !{display: block;margin-left: 25px;margin-right: auto;border:1px solid lightgray;}{{ site.baseurl }}/images/add-new-repository.png!
  40
  41 This will create a new repository with the name @$USER/tutorial@. It can be accessed using the URL <notextile><code>https://git.{{ site.arvados_api_host }}/$USER/tutorial.git</code></notextile> or <notextile><code>git@git.{{ site.arvados_api_host }}:$USER/tutorial.git</code></notextile>
  42
  43 Back in the *Repositories* page, you should see the @$USER/tutorial@ repository listed in the name column with these URLs.
  44
  45 !{display: block;margin-left: 25px;margin-right: auto;}{{ site.baseurl }}/images/added-new-repository.png!
  46
  47 You are now ready to use this *tutorial* repository to run your crunch scripts.