You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: demos/guru_scripts/docker/README.md
+69-30Lines changed: 69 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
-
Overview
2
-
=================
1
+
# Overview
2
+
3
3
This document provides step-by-step instructions on how to pull the latest TigerGraph Free Trial docker image to your host machine. You can follow the sections in sequence to setup the TigerGraph docker enviroment.
4
4
5
5
The latest TigerGraph docker image includes the following content.
@@ -18,8 +18,25 @@ This video shows the whole setup process. https://www.youtube.com/watch?v=V5VvgJ
18
18
19
19
If you want to customize your own docker image, the last section of this README has instructions on how to accomplish it.
# Prepare a Shared Folder on Host OS shared with Docker Container
65
+
----
66
+
49
67
Open a shell on your host machine and create or select a directory for sharing data between your host machine and docker container. Grant read/write/execute permission to the folder. For example, to create a folder called data in Linux:
50
68
51
69
mkdir data
@@ -59,34 +77,39 @@ Suppose we mount the host OS ~/data folder to a docker folder /home/tigergraph/m
59
77
Since our dev edition does not support backup/restore data, you can persist your data (raw file, gsql script etc.)
60
78
on the data volume. After upgrading Dev version, you can start a new container using the same data volume.
61
79
62
-
Getting a License Key (Skip If Using Community Edition)
Please note that this package does not include a license key.
83
+
The following TigerGraph editions are availble for you to choose:
84
+
* Community Edition
85
+
* Enterprise Edition
66
86
67
-
You may obtain a license key by going to [dl.tigergraph.com](https://dl.tigergraph.com/) and clicking on "**Request Free Dev License**" at the top. Fill out the form to receive a license key. Once you have the key, [follow the directions](https://docs.tigergraph.com/tigergraph-server/current/system-management/management-with-gadmin#_manage_licenses) for applying the key.
87
+
## Quick Start for Community Edition
88
+
----
68
89
69
-
Currently, the Free Trial limits your database to **50 GB**, and is valid for **30 days** after the date of issue.
90
+
### Download and Import Pre-built TigerGraph Community Edition Image
70
91
71
-
Quick Start for Community Edition
72
-
================================
73
92
1. Download docker image from https://dl.tigergraph.com/
74
93
2.[Optional for enterprise edition] Download trial license key from https://dl.tigergraph.com/, it's a text file containing the Dev license.
75
94
3. In Macbook/Linux/Windows command line (# starts a comment) type the following sequence of commands, change the image file name to the one you downloaded.
76
95
77
-
```python
96
+
```shell
78
97
docker load -i ./tigergraph-4.2.0-community-docker-image.tar.gz # the xxx.gz file name are what you have downloaded. Change the gz file name depending on what you have downloaded
79
98
docker images #find image id
80
-
docker run -d --name mySandbox imageId #start a container, name it “mySandbox” using the image id you see from previous command
81
-
docker exec-it mySandbox/bin/bash #start a shell on this container.
99
+
docker run -d --init -p 14240:14240 --name tigergraph tigergraph/community:4.2.0 #Run a container named tigergraph from the imported image
100
+
docker exec -it tigergraph /bin/bash #start a shell on this container.
82
101
gadmin start all #start all tigergraph component services
83
102
gadmin status #should see all services are up.
84
103
```
85
-
You are ready to go! Try the [sample financial data](https://github.com/tigergraph/ecosys/blob/master/tutorials/GSQL.md)
104
+
You are ready to go!
105
+
106
+
### Load Sample Database
107
+
108
+
Try the [sample financial data](https://github.com/tigergraph/ecosys/blob/master/tutorials/GSQL.md)
86
109
87
110
For the impatient, load the sample data from the tutorial/gsql folder and run your first query.
88
111
89
-
```python
112
+
```shell
90
113
cd tutorial/gsql/
91
114
gsql 00_schema.gsql #setup sample schema in catalog
92
115
gsql 01_load.gsql #load sample data
@@ -100,24 +123,39 @@ For the impatient, load the sample data from the tutorial/gsql folder and run yo
100
123
GSQL>exit#quit gsql shell
101
124
```
102
125
126
+
### Access UI Apps
127
+
128
+
Visit http://localhost:14240 to access the Apps
129
+
130
+
131
+
## Quick Start for Enterprise Edition
132
+
----
133
+
134
+
### Getting a License Key (No Need If Using Community Edition)
135
+
136
+
Please note that this package does not include a license key.
137
+
138
+
You may obtain a license key by going to [dl.tigergraph.com](https://dl.tigergraph.com/) and clicking on "**Request Free Dev License**" at the top. Fill out the form to receive a license key. Once you have the key, [follow the directions](https://docs.tigergraph.com/tigergraph-server/current/system-management/management-with-gadmin#_manage_licenses) for applying the key.
139
+
140
+
Currently, the Free Trial limits your database to **50 GB**, and is valid for**30 days** after the date of issue.
103
141
If you download enterprise edition, you need to apply the license before you can start.
104
142
```python
105
143
gadmin license set the_license_from_step_2_text #copy the license from step 2 file
106
144
gadmin config apply #apply the license
107
145
```
108
146
109
-
Pull Pre-built TigerGraph Docker Image And Run It As A Server
### Pull Pre-built TigerGraph Docker Image And Run It As A Server
148
+
111
149
One command pull docker image and bind all ports for first time user from the TigerGraph docker registry.
112
150
This image will start as a daemon, so user can ssh to it.
113
151
114
152
1. pull the latest version, only do this step in shell if you upgrade your docker image
115
153
116
154
docker pull tigergraph/tigergraph:latest
117
155
118
-
> Note: replace "latest" with specific version number if a dedicated version of TigerGraph is to be used. E.g. If you want to get 3.6.0 version, the following would be the URL.
156
+
> Note: replace "latest" with specific version number if a dedicated version of TigerGraph is to be used. E.g. If you want to get 4.2.0 version, the following would be the URL.
119
157
120
-
docker pull tigergraph/tigergraph:3.6.0
158
+
docker pull tigergraph/tigergraph:4.2.0
121
159
122
160
> Note:
123
161
>* to use the legacy versions, use docker.tigergraph.com/tigergraph:version
@@ -139,11 +177,11 @@ This image will start as a daemon, so user can ssh to it.
139
177
- "-v" mount the host OS ~/data folder to the docker /home/tigergraph/mydata folder using the -v option. Note that if you are using windows, change the above ~/data to something using windows file system convention, e.g. c:\data
140
178
- download the "latest" docker image from the TigerGraph docker registry url tigergraph/tigergraph.
0 commit comments