https://github.com/mp3monster/oci-arch-oke-graphql

OCI Reference Architecture with example for GraphQL running with API Gateway and OKE
https://github.com/mp3monster/oci-arch-oke-graphql

graphql oci oci-terraform-modules

Last synced: 3 months ago
JSON representation

OCI Reference Architecture with example for GraphQL running with API Gateway and OKE

• Host: GitHub
• URL: https://github.com/mp3monster/oci-arch-oke-graphql
• Owner: mp3monster
• License: other
• Created: 2022-04-28T14:16:24.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-06-22T10:37:27.000Z (almost 3 years ago)
• Last Synced: 2025-01-06T20:36:32.596Z (5 months ago)
• Topics: graphql, oci, oci-terraform-modules
• Language: Python
• Homepage:
• Size: 372 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# OCI Architecture using OKE & GraphQL - Scalable implementation

[![License: UPL](https://img.shields.io/badge/license-UPL-green)](https://img.shields.io/badge/license-UPL-green) [![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=oracle-devrel_test)](https://sonarcloud.io/dashboard?id=oracle-devrel_test)

## Introduction

This Reference Architecture has been implemented to achieve the following:

- Illustrate  how GraphQL can be implemented to be highly scalable (many example implementations put the new logic within the GraphQL Server here we adopt a scalable approach)

- Deployment from OCIR into OKE

- Composability of architectural solutions by deploying this RA on top of a more basic RA.

- Illustrate how we can use OCI API Gateway to implement security in front of a Kubernetes cluster.

The solution deploys three containers that perform the following actions:

- Hosts an instance of the Apollo GraphQL server implemented with Node JS

- A Python 3 service using Flask that servers data for Earthquake events

- A Python 3 service that provides additional data about different Earthquake monitoring stations.

The implementation of these services has taken inspiration from the US Geographical Survey (links provided below). The two Python services take their data from a JSON file held within the service and the files are loaded and processed into memory. As a result, restarting the services will reset the data. 

We have taken this approach to keep the setup simple - so we don't get distracted by the additional effort of configuring database connections.

In the reference diagram, we illustrate the static content being delivered separately. This would be the recommended approach to deploying the static HTML and JavaScript that will drive the presentation view and perform the API calls to retrieve the web application data. This implementation has not implemented this functionality as it doesn't further the goals described in the introduction.

## Getting Started

To be able to experiment with the solution you will need to set up the development tooling described.

### Prerequisites

Regardless of the approach if you want to deploy using any means other than the OCI Console then the following tools are needed. These need to be deployed in this order:

1. OCI CLI

2. Docker

3. Kubectl

#### Developer tooling

- Node JS

- Python 3

- Docker 

- IDE such as Visual Studio Code

#### OCI Setup

The environment setup can be done in several ways. To make life simple and easy to master the development and scaling of GraphQL and OKE we would recommend a developer configuration. Everything is placed into a single compartment. Regardless of the approach, the following order needs to be observed:

1. Create OKE by either - Creating the relevant environment can be done a couple of ways ...

   1. Build on top of an existing RA such as https://github.com/oracle-devrel/terraform-oci-arch-oke.

   2. From scratch

      - If using the Quick Create Wizard, the key is to ensure that endpoints are public and the nodes are private

2. Create the OCIR repository, with the following repositories:

   1. *event-data-svc*

   2. *graphql-svr-svc*

   3. *ref-data-svc*

   - the naming is important, as the names are used within the utility scripts

3. Configuration of the Gateways as described [here](./docs/api-config.md).

4. Ensure that the network security settings needed for the gateway and Kubernetes exist.

5. install the [prerequisites](./README.md#prerequisites) if the microservices are going to be deployed locally

6. Create a secret and apply it to OKE (details  [here](./docs/k8s-configuration#set-secret)).

7. The microservices need to be deployed. The details to do that are [here](./docs/k8s-configuration).

8. With everything deployed, we can exercise the APIs both via the direct strategic approach using the GraphQL server. We have provided some example calls to allow the GraphQL to be exercised here.

## Notes/Issues

To deploy from the relevant OCIR registry we need to set up a secret and incorporate the secret into our deployment commands. This is illustrated at [oracle.com/webfolder/technetwork/tutorials/obe/oci/oke-and-registry/index.html](https://kubernetes.io/docs/tasks/tools/).

More information on how the Kubernetes configuration for the example can be found [here](./docs/k8s-configuration).

#### Potential enhancements

Improvements that could be applied to this solution:

- incorporate the use of Helm charts to deploy the services

- Provide Open API specifications for the API definitions

- Extend the example to use OCI Certificates

- Terraform optional control to enable the Kubernetes Dashboard deployment

## URLs

* [OCIR Overview](https://docs.oracle.com/en-us/iaas/Content/Registry/Concepts/registryoverview.htm)

* [OKE docs](https://docs.oracle.com/en-us/iaas/Content/ContEng/home.htm)

* [OCI CLI](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cliconcepts.htm)

* [Deploying from OCIR into OKE](https://www.oracle.com/webfolder/technetwork/tutorials/obe/oci/oke-and-registry/index.html) - setup steps

* [Installing Kubectl](https://kubernetes.io/docs/tasks/tools/)

* [API Gateway Deployment Parameter Description](https://docs.oracle.com/en-us/iaas/Content/APIGateway/Tasks/apigatewaycreatingdeployment.htm)

#### Learn more about USGS data

Background information on Earthquake monitoring and measurement.

- [USGS Data explanations](https://earthquake.usgs.gov/data/comcat/index.php)

- [Rules for using USGS Data](https://www.usgs.gov/science/faqs/data-tools-and-technology)

- [Example USGS Earthquake Data set](https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/all_month.geojson)

- [GeoJSON](https://geojson.org/) Definition - standard for describing Geographical structures.

- [Contributors to USGS monitoring data](https://earthquake.usgs.gov/data/comcat/contributor/) (the basis of our Reference data service)

## Contributing

This project is open source.  Please submit your contributions by forking this repository and submitting a pull request!  Oracle appreciates any contributions that are made by the open source community.

## License

Copyright (c) 2022 Oracle and/or its affiliates.

Licensed under the Universal Permissive License (UPL), Version 1.0.

See [LICENSE](LICENSE) for more details.

ORACLE AND ITS AFFILIATES DO NOT PROVIDE ANY WARRANTY WHATSOEVER, EXPRESS OR IMPLIED, FOR ANY SOFTWARE, MATERIAL OR CONTENT OF ANY KIND CONTAINED OR PRODUCED WITHIN THIS REPOSITORY, AND IN PARTICULAR SPECIFICALLY DISCLAIM ANY AND ALL IMPLIED WARRANTIES OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.  FURTHERMORE, ORACLE AND ITS AFFILIATES DO NOT REPRESENT THAT ANY CUSTOMARY SECURITY REVIEW HAS BEEN PERFORMED WITH RESPECT TO ANY SOFTWARE, MATERIAL OR CONTENT CONTAINED OR PRODUCED WITHIN THIS REPOSITORY. IN ADDITION, AND WITHOUT LIMITING THE FOREGOING, THIRD PARTIES MAY HAVE POSTED SOFTWARE, MATERIAL OR CONTENT TO THIS REPOSITORY WITHOUT ANY REVIEW. USE AT YOUR OWN RISK.