Skip to content

Latest commit

 

History

History
374 lines (264 loc) · 16.6 KB

README.md

File metadata and controls

374 lines (264 loc) · 16.6 KB

From Zero to WOW in 5 minutes

  • Generates the source code for a pre-configured REACT frontend, JET frontend, or for the Spring-Boot Petclinic web application
  • Provisions an autonomous backend (Always Free autonomous database + REST Data Services)
  • (optional) Loads your JSON data into your collection(s)
  • (optional) Loads your CSV data into your table(s)

... in 5 minutes.

React.js frontend Oracle JavaScript Extension Toolkit Spring Boot application Autonomous Database Polyglot GraalVM REST Data Services Node.js

30 seconds installation steps

Youtube! overview

Download

The latest stable release is v2.2.0.

Linux and OCI Cloud Shell

rm -f ./dragon-linux-x86_64-2.2.0
wget https://github.com/loiclefevre/dragon/releases/download/v2.2.0/dragon-linux-x86_64-2.2.0
chmod +x dragon-linux-*

Learn about OCI Cloud shell.

Linux ARM

rm -f ./dragon-linux-aarch_64-2.2.0
wget https://github.com/loiclefevre/dragon/releases/download/v2.2.0/dragon-linux-aarch_64-2.2.0
chmod +x dragon-linux-*

Learn about Always Free cloud services now including free ARM Ampere A1 Compute shapes (up to 4 cores and up to 24 GB or RAM).

Windows

powershell wget https://github.com/loiclefevre/dragon/releases/download/v2.2.0/dragon-windows-x86_64-2.2.0.exe -OutFile dragon-windows-x86_64-2.2.0.exe

MAC OS

You'd need to clear the quarantine flag of the application once downloaded

curl -L -O https://github.com/loiclefevre/dragon/releases/download/v2.2.0/dragon-osx-x86_64-2.2.0
chmod +x dragon-osx-*
sudo xattr -r -d com.apple.quarantine dragon-osx-x86_64-2.2.0

Getting Started

To get started, you can go through the DRAGON LiveLabs.

Changelog

See the changelog here.

Configure

The DRAGON Stack manager is driven by the command line arguments and the configuration file named dragon.config present in your current directory:

CLI arguments

Configuration file

If no dragon.config exist in the current directory, then by running the dragon stack CLI, you get a default configuration template to complete and write into the file dragon.config. It includes various links to Oracle Cloud Infrastructure documentation to get you started.

REMARK: Please notice that (as of now) only one database can be provisioned for a given dragon.config file and hence for a given directory.

New with v2.0.4, using the -create-keys parameter along the -config-template command makes the whole process of generating API Keys pair a non-event!

 # DEFAULT profile (case sensitive), you can define others: ASHBURN_REGION or TEST_ENVIRONMENT
 # You can choose a profile using the -profile command line argument
 # WARNING: any property not defined inside the selected profile will use the one from the DEFAULT profile 
 #          if found, hence the name of the profile: DEFAULT :) 
[DEFAULT]

 # OCID of the user connecting to Oracle Cloud Infrastructure APIs. To get the value, see:
 # https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#five
user=ocid1.user.oc1..<unique_ID>

 # Full path and filename of the SSH private key (use *solely* forward slashes).
 # /!\ Warning: The key pair must be in PEM format. For instructions on generating a key pair in PEM format, see:
 # https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#Required_Keys_and_OCIDs
key_file=<full path to SSH private key file>

 # Uncomment in the case your SSH private key needs a pass phrase.
# pass_phrase=<pass phrase to use with your SSH private key>

 # Fingerprint for the SSH *public* key that was added to the user mentioned above. To get the value, see:
 # https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#four
fingerprint=<fingerprint associated with the corresponding SSH *public* key>

 # OCID of your tenancy. To get the value, see:
 # https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#five
tenancy=ocid1.tenancy.oc1..<unique_ID>

 # An Oracle Cloud Infrastructure region identifier. For a list of possible region identifiers, check here:
 # https://docs.cloud.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm#top
region=eu-frankfurt-1

 # OCID of the compartment to use for resources creation. to get more information about compartments, see:
 # https://docs.cloud.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcompartments.htm?Highlight=compartment%20ocid#Managing_Compartments
compartment_id=ocid1.compartment.oc1..<unique_ID>

 # Authentication token that will be used for OCI Object Storage configuration, see:
 # https://docs.cloud.oracle.com/en-us/iaas/Content/Registry/Tasks/registrygettingauthtoken.htm?Highlight=user%20auth%20tokens
auth_token=<authentication token>

 # Autonomous Database Type:
 # - atpfree: Always Free Autonomous Transaction Processing (default)
 # - ajdfree : Always Free Autonomous JSON Database
 # - apexfree: Always Free Autonomous Application Express
 # - adwfree: Always Free Autonomous Data Warehouse
 # - atp     : Autonomous Transaction Processing
 # - ajd     : Autonomous JSON Database
 # - apex    : Autonomous Application Express
 # - adw     : Autonomous Data Warehouse
# database_type=atpfree

 # Autonomous Database Version:
 # - 19c (default)
 # - 21c
database_version=19c

 # Uncomment to specify another database user name than dragon (default)
# database_user_name=<your database user name>

 # The database password used for database creation and dragon user
 # - 12 chars minimum and 30 chars maximum
 # - can't contain the "dragon" word
 # - contains 1 digit minimum
 # - contains 1 lower case char
 # - contains 1 upper case char
database_password=<database password>

 # Uncomment to ask for Bring Your Own Licenses model (doesn't work for Always Free and AJD)
# database_license_type=byol

 # Path to a folder where data to load into collections can be found (default to current directory)
data_path=.

 # A list of coma separated JSON collection name(s) that you wish to get right after database creation
# database_collections=

 # A list of coma separated table name(s) that you wish to get right after database creation
 # These table must have corresponding CSV file(s) so that table structure (DDL) is deduced from the files
# database_tables=

Run

Example from OCI Cloud Shell (Linux):

Run

(you must have a valid dragon.config file in the current directory)

Linux and OCI Cloud Shell:

$ ./dragon-linux-x86_64-2.2.0

Linux on ARM infrastructure:

$ ./dragon-linux-aarch_64-2.2.0

Windows:

> dragon-windows-x86_64-2.2.0.exe

MAC OS:

$ ./dragon-osx-x86_64-2.2.0

Oracle Cloud Infrastructure Policy

In order for the DRAGON Stack manager to be able to do its job, an OCI Policy must be set if you are not the administrator of the cloud tenant. If you are using an OCI user who has admin privileges (belongs to group OCI Administrators), then no additional configuration is required. If you don't belong to the OCI Administrators group, then ask your admin to create the following policy (for the compartment /demos/json) and make you belong to the associated group:

Allow group DRAGON_Stack_Developers to manage buckets in compartment demos:json
Allow group DRAGON_Stack_Developers to manage objects in compartment demos:json
Allow group DRAGON_Stack_Developers to manage autonomous-database-family in compartment demos:json
Allow group DRAGON_Stack_Developers to inspect work-requests in compartment demos:json
Allow group DRAGON_Stack_Developers to read resource-availability in compartment demos:json
Allow group DRAGON_Stack_Developers to use cloud-shell in tenancy
Allow group DRAGON_Stack_Developers to inspect limits in tenancy

Eventually, you may ask for some quota to be set on your compartment as well.

Loading JSON data

If you need to create JSON collections during the provisioning process, you may use the configuration file parameter database_collections (see hereunder). If you also need to load existing JSON data into these collections, you may put your JSON documents in files having the same name as the collection name plus the .json extension. These files must be of JSON dump format with exactly one JSON document per line. No array, no comma separating the documents but carriage returns! Your files will be loaded only if you ask for it using the -loadjson CLI argument.

To load JSON data as well as provisioning (Linux and OCI Cloud Shell):

$ ./dragon-linux-x86_64-2.2.0 -loadjson

To load JSON data as well as provisioning and finally create a React application (Linux and OCI Cloud Shell):

$ ./dragon-linux-x86_64-2.2.0 -loadjson -create-react-app myfrontend

Loading CSV data

If you need to load CSV data into tables during the provisioning process (or even after), you can use the configuration file parameter database_tables (see hereunder). You'll list the names (without file extension, separated by a comma) of CSV files present in the data_path directory (current directory by default). These files must have a header! Your CSV files will be loaded only if you ask for it using the -loadcsv CLI argument. In the targeted table doesn't exist, it will be created and its structure will be deduced from the CSV data automatically.

To load CSV data as well as provisioning (Linux and OCI Cloud Shell):

$ ./dragon-linux-x86_64-2.2.0 -loadcsv

To load CSV data as well as provisioning and finally create a React application (Linux and OCI Cloud Shell):

$ ./dragon-linux-x86_64-2.2.0 -loadcsv -create-react-app myfrontend

Destroying your database

To destroy your database (Linux and OCI Cloud Shell):

$ ./dragon-linux-x86_64-2.2.0 -destroy

Stacks

DRAGON Stack manager as its name implies is able to deploy complete Stacks. These stacks contain the database as well as application source code.

The following application examples are supported:

React frontend

As of v2.0.1, DRAGON can now generate stacks. The very first stack proposed is a React frontend.

Giving this result in your browser:

Accessing ports on OCI Cloud Shell

For OCI Cloud Shell, you may use NGROK (free version) to allow access to your website deployed locally.

wget https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-amd64.zip

unzip ngrok-stable-linux-amd64.zip

npm start &

For React frontend:

./ngrok http 3000

Overriding this stack

Over time, additional templates are being released to improve the existing base stacks. These overrides can be discovered in the stacks folder.

$ ./dragon-linux-x86_64-2.2.0 -create-react-app#lab2 myfrontend

The lab2 for example extends the default React frontend stack with a React-Table:

Oracle JavaScript Extension Toolkit frontend

As of v2.1.0, DRAGON can now generate Oracle JET stacks. Thanks a lot to Paolo Bellardone for doing this integration inside DRAGON!

Giving this result in your browser:

Accessing ports on OCI Cloud Shell

For OCI Cloud Shell, you may use NGROK (free version) to allow access to your website deployed locally.

wget https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-amd64.zip

unzip ngrok-stable-linux-amd64.zip

npm start &

For Oracle JET frontend:

./ngrok http 8000

Spring-Boot petclinic webapp

As of v2.0.3, DRAGON can now generate a Spring-Boot based stack including the well known petclinic web application.

Accessing ports on OCI Cloud Shell

For OCI Cloud Shell, you may use NGROK (free version) to allow access to your web application deployed locally.

wget https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-amd64.zip

unzip ngrok-stable-linux-amd64.zip

java -jar target/*.jar &

For Spring-Boot web application:

./ngrok http 8080

Microservice backend

Microservice backend can now be deployed using the DRAGON Stack manager. Because of the relative complexity of such eco-system, DRAGON will not come with default microservice templates but instead provide, through its override mechanism, a set of templates.

$ ./dragon-linux-x86_64-2.2.0 -create-micro-service#json-po-generator

Running this command will provide you a simple micro-service that can be used for demoing JSON data ingestion in Oracle Autonomous databases using the Simple Oracle Document Access API (SODA).

Why Autonomous Database for Developers?

Simple to use, it works, it is optimized already, no administrative burdens, develop right away!

Converged, it means, you get the consistency of a relational database, the flexibility of a JSON database, the simplicity of Machine Learning in the database, the location capabilities of a spatial database, the power of a property graph database, the indexing capabilities of a full-text database, the automatic elasticity as well as the costing model (always free version, pay by the second...) of a cloud native database, the performance of the underlying infrastructure Exadata, the strongest security of the database market, and the vast developer friendly ecosystem brought by Oracle Cloud Infrastructure.

Autonomous Database can be:

  • Always Free Autonomous Transaction Processing (ATP, aka Converged Database)
  • Always Free Autonomous JSON Database (AJP, same as ATP 25% the price in case you upgrade to the paid version and limited to 20 GB of relational data)
  • Always Free Autonomous Application Express (APEX, the Low-Code application development environment)
  • Always Free Autonomous Data Warehouse (ADW)
  • Autonomous Transaction Processing (ATP)
  • Autonomous JSON Database (AJD)
  • Autonomous Application Express (APEX)
  • Autonomous Data Warehouse

Thanks

I would like to thank the people that contributed to this project:

GraalVM Native Image Compression

You can get more information in my post on the GraalVM blog: