diff --git a/README.md b/README.md index fbe7391..d6dc501 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,73 @@ This terraform module allows you to deploy GraphDB instance in GCE(Google Compute Engine). +## Table of contents + +- [About GraphDB](#about-graphdb) +- [Features](#features) +- [Versioning](#versioning) +- [Prerequisites](#prerequisites) +- [Inputs](#inputs) +- [Quick Start](#quickstart) +- [Metadata](#metadata) +- [Resources](#resources) +- [Local Development](#local-development) +- [Release History](#release-history) +- [Contributing](#contributing) +- [License](#license) + +## About GraphDB + +

+ + + GraphDB logo + + +

+ +Ontotext GraphDB is a highly efficient, scalable and robust graph database with RDF and SPARQL support. With excellent +enterprise features, +integration with external search applications, compatibility with industry standards, and both community and commercial +support, GraphDB is the +preferred database choice of both small independent developers and big enterprises. + +## Features + +The module provides the building blocks of configuring, deploying and provisioning a single VM of GraphDB +using Google Compute Engine. Key features of the module include: + +- Google Cloud Engine Compute Instance +- Google Compute Firewall + +## Versioning + +The Terraform module follows the Semantic Versioning 2.0.0 rules and has a release lifecycle separate from the GraphDB +versions. The next table shows the version compatability between GraphDB, and the Terraform module. + +| GraphDB Terraform | GraphDB | +|--------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| +| [Version 0.0.1](https://github.com/Ontotext-AD/terraform-gcp-graphdb/releases) | [Version 10.7.x](https://graphdb.ontotext.com/documentation/10.7/release-notes.html) | + +You can track the particular version updates of GraphDB in the [changelog](CHANGELOG.md). + +## Prerequisites + +Before you begin using this Terraform module, ensure you meet the following prerequisites: + +- **Google Cloud CLI**: + [Google Cloud CLI](https://cloud.google.com/sdk/docs/install) + +- **Terraform Installed**: You should have Terraform installed on your local machine. You can download Terraform from + the [https://developer.hashicorp.com/terraform/install?product_intent=terraform](Terraform website). + +- **Google Cloud Credentials**: Ensure that you have AWS credentials configured on your machine. You can configure AWS access + keys and secret keys using the [AWS CLI](https://cloud.google.com/docs/authentication/gcloud). + +- **Terraform Google Cloud Provider Configuration**: Configure the AWS provider in your Terraform project. You can add your AWS + access and secret keys as environment variables or use other methods for provider configuration. + ## Inputs @@ -18,17 +85,6 @@ This terraform module allows you to deploy GraphDB instance in GCE(Google Comput | allowed\_ingress\_cidrs | CIDR blocks that are allowed to access the GraphDB port | `list(string)` | ```[ "0.0.0.0/0" ]``` | no | -## Versioning - -The Terraform module follows the Semantic Versioning 2.0.0 rules and has a release lifecycle separate from the GraphDB -versions. The next table shows the version compatability between GraphDB, and the Terraform module. - -| GraphDB Terraform | GraphDB | -|--------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| -| [Version 0.0.1](https://github.com/Ontotext-AD/terraform-gcp-graphdb/releases) | [Version 10.7.x](https://graphdb.ontotext.com/documentation/10.7/release-notes.html) | - -You can track the particular version updates of GraphDB in the [changelog](CHANGELOG.md). - ## Quickstart ```shell