Skip to content
No description, website, or topics provided.
Ruby Shell Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
deploy
nginx
.dockerignore
.gitignore
Dockerfile
Jenkinsfile
Makefile
README.md
install-nginx.sh

README.md

NGINX Microservices Reference Architecture: Album Manager Service

This repository contains a simple Ruby application which provides functionality to create and update albums for the NGINX Ingenious application. The Ingenious application has been developed by the NGINX Professional Services team to provide a reference architecture for building your own microservices based application using NGINX as the service mesh for the services.

The Album Manager application is configured to retrieve data from other components in the NGINX Microservice Reference Architecture:

The default configuration for all the components of the MRA, including the Album Manager service, is to use the Fabric Model Architecture. Instructions for using the Router Mesh or Proxy Model architectures will be made available in the future.

Quick start

As a single service in the set of services which comprise the NGINX Microservices Reference Architecture application, Ingenious, the Album Manager service is not meant to function as a standalone service. Once you have built the image, it can be deployed to a container engine along with the other components of the Ingenious application, and then the application will be accessible via your browser.

There are detailed instructions for building the service below, and in order to get started quickly, you can follow these simple instructions to quickly build the image.

  1. (Optional) If you don't already have an NGINX Plus license, you can request a temporary developer license here. If you do have a license, then skip to the next step.
  2. Copy your licenses to the /mra-album-manager/nginx/ssl directory
  3. Run the command docker build . -t <your-image-repo-name>/album-manager:quickstart where is the username for where you store your Docker images
  4. Once the image has been built, push it to your image repository with the command docker push -t <your-image-repo-name>/album-manager:quickstart

At this point, you will have an image that is suitable for deployment on to a Kubernetes installation, and you can deploy the image by creating YAML files and uploading them to your Kubernetes installation.

To build a customized image for different container engines or to set other options, please follow the directions below.

Building a Customized Docker Image

The Dockerfile for the Album Manager service is based on the ruby:2.2.3 image, and installs NGINX open source or NGINX Plus. Note that NGINX Plus includes features which make discovery of other services possible, include additional load balancing algorithms, create persistent SSL/TLS connections, and provide advanced health check functionality.

Please refer to the comments in the Dockerfile for details about each command which is used to build the image.

The command, or entrypoint, for the Dockerfile is the start.sh script. This script sets some local variables, then starts unicorn and NGINX in order to handle page requests. Configuration for unicorn is found in the unicorn.rb file

1. Build options

The Dockerfile sets some ENV arguments which are used when the image is built:

  • USE_NGINX_PLUS
    The default value is true. When this value is set to false, NGINX open source will be built in to the image and several features, including service discovery and advanced load balancing will be disabled. See installing nginx plus

  • USE_VAULT
    The default value is false. Setting this value to true will cause install-nginx.sh to look for a file named vault_env.sh which contains the VAULT_ADDR and VAULT_TOKEN environment variables to retrieve NGINX Plus keys from a vault server.

    #!/bin/bash
    export VAULT_ADDR=<your-vault-address>
    export VAULT_TOKEN=<your-vault-token>
    

    You must be certain to include the vault_env.sh file when USE_VAULT is true. There is an entry in the .gitignore file for vault_env.sh

    In the future, we will release an article on our blog describing how to use vault with NGINX.

  • CONTAINER_ENGINE
    The container engine used to run the images in a container. CONTAINER_ENGINE can be one of the following values

2. Decide whether to use NGINX Open Source or NGINX Plus

Installing NGINX Open Source

Set the USE_NGINX_PLUS property to false in the Dockerfile

Installing NGINX Plus

Before installing NGINX Plus, you'll need to obtain your license keys. If you do not already have a valid NGINX Plus subscription, you can request developer licenses here

Set the USE_NGINX_PLUS property to true in the Dockerfile

By default USE_VAULT is set to false, and you must manually copy your nginx-repo.crt and nginx-repo.key files to the /mra-album-manager/nginx/ssl/ directory.

Download the nginx-repo.crt and nginx-repo.key files for your NGINX Plus Developer License or subscription, and move them to the root directory of this project. You can then copy both of these files to the /nginx/ssl directory of each microservice using the command below:

cp nginx-repo.crt nginx-repo.key <repository>/nginx/ssl/

If USE_VAULT is set to true, you must have installed a vault server and written the contents of the nginx-repo.crt and nginx-repo.key file to vault server. Refer to the vault documentation for instructions configuring a vault server and adding values to it.

3. Decide which container engine to use

Set the CONTAINER_ENGINE variable

As described above, the CONTAINER_ENGINE environment variable must be set to one of the following three options. The install-nginx.sh file uses this value to determine which template file to use when populating the nginx.conf file.

  • kubernetes
  • mesos
  • local

4. Build the image

Replace <your-image-repo-name> with the username for where you store your Docker images, and execute the command below to build the image. The <tag> argument is optional and defaults to latest

docker build . -t <your-image-repo-name>/album-manager:<tag>

5. Runtime environment variables

In order to run the image, some environment variables must be set so that they are available during runtime.

Variable Name Description Example Value
DATABASE_HOST Host of the database mysql
DATABASE_PASSWORD mra_dev
DATABASE_USERNAME root
PORT Database port 3307
UPLOADER_PHOTO Host of the uploader to delete an image http://localhost/uploader/image/uploads/photos/
DEBUG To get more descriptive logging true

6. Service Endpoints

Method Endpoint Description Parameters
GET / Succesful operation
GET /albums Fetch all albums
POST /albums Create new album body - album information
GET /albums/{id} Fetch an album by id id - id for album
PUT /albums/{id} Update existing album id - id for album
PATCH /albums/{id}/public/{boolean} Update existing album to make it public id - id for album
DELETE /albums/{id} Delete an album by id id - id of album
GET /public/{id} Fetch a public album by id id - id of album
GET /images Fetch all images
POST /images Create new image body - image information
GET /images/{id} Fetch an image by id id - id for user
PUT /images/{id} Update existing image by id body - image information
DELETE /images/{id}/{uuid} Delete an image by id id - id of image, uuid - unique user identifier

Disclaimer

In this service, the nginx/ssl/dhparam.pem file is provided for ease of setup. In production environments, it is highly recommended for secure key-exchange to replace this file with your own generated DH parameter.

You can generate your own dhparam.pem file using the command below:

openssl dhparam -out nginx/ssl/dhparam.pem 2048
You can’t perform that action at this time.