How to define a Git project in Krugle

1
How to define a Git project in Krugle
To search Git code (or any other version controlled data in the Git repository) in Krugle you will
need to (A) create a Git Data Repository and (B) create a Krugle Project with that Data
Repository. Details for these steps:
Create a Git SCMI Data Repository
1)
Make sure the Git SCMI service is running on your network. Note the IP address
(including the port identifier).
2)
Sign in to the Krugle Administration Console from an internet browser. Enter the
host name URL assigned to Krugle Enterprise during the initial installation
process, with ":8080" appended to the end of the URL as the port
Krugle SCMI Reference – Git 03.14
2
3)
Enter valid administration credentials (e.g. those specified during initial
installation of Krugle Enterprise) to Sign In to Krugle. You will then see the
Status tab of the Administration Console:
4)
Click the Projects tab to go to Projects Summary page:
Krugle SCMI Reference – Git 03.14
3
5)
Click the Data Repositories option in the left navigation pane. You’ll see the
Data Repositories that are currently defined in your system. These Data
Repositories are database records stored in Krugle that contain the information
that Krugle needs to connect to information servers on your network:
6)
To add a Repository in Krugle that will store your Git information, click the Add
New Data Repository button. You will then see the Data Repository definition
page:
7)
Select SCMI from the Data Repository Type drop down list – as shown below:
Krugle SCMI Reference – Git 03.14
4
8)
Enter the verified IP address or hostname which corresponds to the Git Service
(see step 1 above) repository:
9)
Click Next button to continue defining the Data Repository:
10)
Enter a descriptive name for the Data Repository. Unless specifically directed by
Krugle, you won’t need to change the Path, Port or Connection Type fields:
Krugle SCMI Reference – Git 03.14
5
11)
Click Save button to complete the specification of the new Data Repository. You’ll
return to the Data Repository summary page – as shown below:
This completes the process of creating a Data Repository. In the following section, we’ll create a
Krugle Project that incorporates this Data Repository to specify the selected data from the
repository (all of it or part of it) – that Krugle will search.
Create a Krugle Project with Git Data Repository
A Krugle Project is a definition of the specific data that you want Krugle to crawl.
A Krugle Project can contain all of the information in a Git repository (or several
repositories), or just a portion of that information. Additionally, the Krugle Project
can be specified to crawl that information once or to automatically re-crawl and
update that information in the future.
Krugle SCMI Reference – Git 03.14
6
In this section, we explain the basic options in setting up a Krugle Project for the
jQuery project available at Github https://github.com/jquery/jquery:
To access the project information, follow the github URL above. We use this page
to copy the cone URL (see note in screen above), which will be the address
Krugle uses to access the project files.
To specify the information that Krugle will extract from Git, navigate to the
Projects Summary page in the Krugle Admin console (see Step 2 above if you’re
currently not signed in to the Admin console):
Krugle SCMI Reference – Git 03.14
7
Next:
1) In Project Summary page, click the Add New Project option located directly
beneath and to the right of the Snapshot Status area:
2) On the Add/Edit Project page, click the Advanced Setting link:
Krugle SCMI Reference – Git 03.14
8
3) Enter the Project information requested in the form. Fields marked with a *
are required:
4) Click the Next button after entering the Project metadata into the form. You
will go to the second step of Add/Edit Project page:
Krugle SCMI Reference – Git 03.14
9
5) Select the Data Repository which you created in previous section from the
dropdown list (in the following screen, we are selecting the Git-SCMI):
6) After selecting the Git-SCMI item, enter the information shown below:
Krugle SCMI Reference – Git 03.14
10
7) Enter the Location (where the address to clone the git repository as shown
in this part beginning), the Parameter (login credentials) and Alias fields.
When finished, Click the Add Data Set button:
8) Click the Finish button to create the Krugle Project. NOTE: this example
uses only one Data Set; multiple Data Sets are supported – but not
demonstrated here.
Krugle SCMI Reference – Git 03.14
11
9) You will be redirected to the Project Summary page where the newly created
project will be displayed:
10) At this point, Krugle will begin to crawl and index your project. After these
steps are successfully completed, you will see a Green check icon in the
Status column for the project:
Krugle SCMI Reference – Git 03.14
12
This completes the specification of a Krugle Project for Git. This information can
now be searched.
If you want to search Krugle for information from Git:
● Go to Krugle Search Environment(KSE), point your browser to the URL
shown in the VMware console window when Krugle was installed. In this
example, that URL is http://192.168.2.188:
Krugle SCMI Reference – Git 03.14
13
● Enter the search term like: project:git-jquery, where “git-jquery” is the
project name you created.
● For this term, Krugle will search and list all work items and work item
attachments in these in the project git-jquery. The results will appear as a
list in the Krugle Search Environment results page:
●
You can click any file name link (blue text) from the result list to view
details of that result. For example, clicking “.bowerrc”:from the preceding
list will display the contents of that file:
Krugle SCMI Reference – Git 03.14
14
Krugle SCMI Reference – Git 03.14