Install GoodData.CN Container Edition

GoodData.CN Container Edition docker image is a full-fledged evaluation package which allows you to deploy and test GoodData.CN quickly.

The image includes a PostgreSQL database with sample data, so you don’t need any data or data source to try out GoodData.CN analytics platform.

Requirements

You can deploy the GoodData.CN Container Edition docker image on hardware or on a VM in any cloud environment that meets the following requirements.

Please note that you need a valid GoodData.CN license key to run the container.

Minimal HW Resources

• 64-bit Intel, AMD or ARM64 processor with at least 4 cores
• 5 GB available RAM (more may be needed on Apple with M1 processor)
• 2 GB free disk space

Tools

• Docker Engine

Installation

1. Pull the image:

   Bash

   PowerShell 7

     ```bash
     docker pull gooddata/gooddata-cn-ce:3.1.0
     ```
   

     ```powershell
     docker pull gooddata/gooddata-cn-ce:3.1.0
     ```
   

2. Start the image with exposed port and interactive terminal:

   Bash

   PowerShell 7

   docker run GDCN_LICENSE_KEY="key/eyJwcm9kdWN0Ijp7Imlk..." -i -t -p 3000:3000 -p 5432:5432 -v gd-volume:/data \
   gooddata/gooddata-cn-ce:3.1.0
   

   docker run GDCN_LICENSE_KEY -i -t -p 3000:3000 -p 5432:5432 -v gd-volume:/data `
   gooddata/gooddata-cn-ce:3.1.0
   

   Set Up the License Key in Your Shell Profile

   To avoid having to paste the entire license key into the run command, you may want to add the license key to your shell environment. This can be done by updating your shell profile script. Depending on your shell, open either .bashrc (for bash) or .zshrc (for zsh) in your favorite text editor. Append the following line at the end of the file:

   export GDCN_LICENSE_KEY="key/eyJwcm9kdWN0Ijp7Imlk..."

   Save the file and either restart your shell or source the profile script with source ~/.bashrc or source ~/.zshrc to ensure the environment variable is set.

   Docker Volume Management

   The command will create and attach a data volume for your container. The volume can be reused for a new container when the old container is stopped. Data in the container are going to be upgraded automatically in case you start a new version of GoodData.CN Container Edition.

   Use docker volume rm gd-volume to remove the volume in case you want to start from scratch.

   When the docker container starts for the first time, you will be presented with the GOODDATA.CN CONTAINER EDITION LICENSE AGREEMENT (“License”), including GoodData’s Privacy Policy. Please read it carefully. In order to use GoodData.CN, you must agree to the terms and conditions therein.

   After you have accepted the License for the first time, if you wish to use GoodData.CN without interacting with starting docker container, it is possible to accept the GOODDATA.CN CONTAINER EDITION LICENSE AGREEMENT by passing the environment variable LICENSE_AND_PRIVACY_POLICY_ACCEPTED=YES to the docker run command:

   Bash

   PowerShell 7

   docker run GDCN_LICENSE_KEY -p 3000:3000 -p 5432:5432 -v gd-volume:/data \
      -e LICENSE_AND_PRIVACY_POLICY_ACCEPTED=YES gooddata/gooddata-cn-ce:3.1.0
   

   docker run GDCN_LICENSE_KEY -p 3000:3000 -p 5432:5432 -v gd-volume:/data `
      -e LICENSE_AND_PRIVACY_POLICY_ACCEPTED=YES gooddata/gooddata-cn-ce:3.1.0
   

   Startup warning

   Starting a container requires approximately two minutes until it becomes fully initialized (depending on your HW), and it logs a lot of information to standard output.

   When the log output contains the following message, the container is ready to use:

   /============= All services of GoodData.CN are ready ==============\
   |                                                                  |
   | Navigate your browser to http://localhost:3000/                  |
   |                                                                  |
   | You can log in as user demo@example.com with password demo123    |
   | To access API, use Bearer token YWRtaW46Ym9vdHN0cmFwOmFkbWluMTIz |
   |                                                                  |
   \============= All services of GoodData.CN are ready ==============/
   

3. Navigate to http://localhost:3000/ in browser.

   You will be redirected to a login page, use the following credentials of a demo user which is prepared in GoodData.CN Container Edition:

   • email: demo@example.com
   • password: demo123

After a successful login you are ready on the home page, and you can start exploring.

Development version of GoodData.CN Container Edition

We provide development releases of our product besides standard GoodData.CN Container Edition. Development releases serve as a preview of upcoming features. These releases may be buggy or contain features that do not make their way into our regular GoodData.CN distributions, therefore we do not recommend doing development work with them or using them to evaluate GoodData.CN.

Both standard and development releases share the same Docker Hub registry. We are using the following tags to distinguish between versions:

• Tag latest

  This tag always directs to the newest standard release of GoodData.CN Container Edition. Use this tag if you want to evaluate GoodData.CN as this version contains the latest features.

• Tags in semantic version format

  We use tags in semver format (major.minor.patch - e.g. 1.6.0) for standard versions of GoodData.CN Container Edition.

• Timestamp-based tags

  We use tags in format dev_YYYYMMDD.COMMIT_ID for development releases.

• Tag dev_latest

  This tag points to the latest development release.