Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/GoogleCloudPlatform/nginx-docker

Last synced: 14 days ago
JSON representation

Host: GitHub
URL: https://github.com/GoogleCloudPlatform/nginx-docker
Owner: GoogleCloudPlatform
License: bsd-2-clause
Created: 2017-04-28T18:50:49.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2024-09-17T10:40:28.000Z (about 2 months ago)
Last Synced: 2024-10-29T19:33:57.696Z (15 days ago)
Language: Dockerfile
Size: 4.82 MB
Stars: 40
Watchers: 28
Forks: 34
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

nginx-docker
============

Dockerfile source for nginx [docker](https://docker.io) image.

# Upstream
This source repo was originally copied from:
https://github.com/nginxinc/docker-nginx

# Disclaimer
This is not an official Google product.

# About

This image contains an installation Nginx 1.x.

For more information, see the
[Official Image Marketplace Page](https://console.cloud.google.com/marketplace/details/google/nginx1).

Pull command (first install [gcloud](https://cloud.google.com/sdk/downloads)):

```shell
gcloud auth configure-docker && docker -- pull marketplace.gcr.io/google/nginx1
```

Dockerfile for this image can be found [here](https://github.com/GoogleCloudPlatform/nginx-docker/tree/master/1).

# Table of Contents
* [Using Kubernetes](#using-kubernetes)
* [Running Nginx](#running-nginx-kubernetes)
* [Start a Nginx web server](#start-a-nginx-web-server-kubernetes)
* [Use a persistent data volume](#use-a-persistent-data-volume-kubernetes)
* [Web server configuration](#configuration-kubernetes)
* [Viewing existing configuration](#viewing-existing-configuration-kubernetes)
* [Using configuration volume](#using-configuration-volume-kubernetes)
* [Moving the web content to Nginx](#move-web-content-kubernetes)
* [Testing the web server](#testing-the-web-server-kubernetes)
* [Accessing the web server from within the container](#accessing-the-web-server-from-within-the-container-kubernetes)
* [Using Docker](#using-docker)
* [Running Nginx](#running-nginx-docker)
* [Start a Nginx web server](#start-a-nginx-web-server-docker)
* [Use a persistent data volume](#use-a-persistent-data-volume-docker)
* [Web server configuration](#configuration-docker)
* [Viewing existing configuration](#viewing-existing-configuration-docker)
* [Using configuration volume](#using-configuration-volume-docker)
* [Moving the web content to Nginx](#move-web-content-docker)
* [Testing the web server](#testing-the-web-server-docker)
* [Accessing the web server from within the container](#accessing-the-web-server-from-within-the-container-docker)
* [References](#references)
* [Ports](#references-ports)
* [Volumes](#references-volumes)

# Using Kubernetes

Consult [Marketplace container documentation](https://cloud.google.com/marketplace/docs/container-images)
for additional information about setting up your Kubernetes environment.

## Running Nginx

### Start a Nginx web server

Copy the following content to `pod.yaml` file, and run `kubectl create -f pod.yaml`.

```yaml
apiVersion: v1
kind: Pod
metadata:
name: some-nginx
labels:
name: some-nginx
spec:
containers:
- image: marketplace.gcr.io/google/nginx1
name: nginx
```

Run the following to expose the ports.
Depending on your cluster setup, this might expose your service to the
Internet with an external IP address. For more information, consult
[Kubernetes documentation](https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/).

```shell
kubectl expose pod some-nginx --name some-nginx-80 \
--type LoadBalancer --port 80 --protocol TCP
kubectl expose pod some-nginx --name some-nginx-443 \
--type LoadBalancer --port 443 --protocol TCP
```

For information about how to retain your data across restarts, see [Use a persistent data volume](#use-a-persistent-data-volume-kubernetes).

For information about how to configure your web server, see [Web server configuration](#configuration-kubernetes).

### Use a persistent data volume

To preserve your web server data when the container restarts, put
the web content directory on a persistent volume.

By default, `/usr/share/nginx/html` directory on the container houses all the web content files.

Copy the following content to `pod.yaml` file, and run `kubectl create -f pod.yaml`.

```yaml
apiVersion: v1
kind: Pod
metadata:
name: some-nginx
labels:
name: some-nginx
spec:
containers:
- image: marketplace.gcr.io/google/nginx1
name: nginx
volumeMounts:
- name: webcontent
mountPath: /usr/share/nginx/html
volumes:
- name: webcontent
persistentVolumeClaim:
claimName: webcontent
---
# Request a persistent volume from the cluster using a Persistent Volume Claim.
kind: PersistentVolumeClaim
apiVersion: v1
metadata:
name: webcontent
annotations:
volume.alpha.kubernetes.io/storage-class: default
spec:
accessModes: [ReadWriteOnce]
resources:
requests:
storage: 5Gi
```

The web server configuration should also be on a persistent volume. For more information, see [Web server configuration](#configuration-kubernetes).

## Web server configuration

### Viewing existing configuration

Nginx configuration file is at `/etc/nginx/nginx.conf`.

```shell
kubectl exec some-nginx -- cat /etc/nginx/nginx.conf
```

### Using configuration volume

The default `nginx.conf` includes all configuration files under `/etc/nginx/conf.d` directory. If you have a `/path/to/your/site.conf` file locally, you can start the server as followed to mount it under `conf.d` directory.

Create the following `configmap`:

```shell
kubectl create configmap site-conf \
--from-file=/path/to/your/site.conf
```

Copy the following content to `pod.yaml` file, and run `kubectl create -f pod.yaml`.

### Moving the web content to Nginx

We can move the web content to the container with the commands below, assuming `/usr/share/nginx/html` is where nginx has been configured to read from.

Create the directory if it does not exist yet.

```shell
kubectl exec some-nginx -- mkdir -p /usr/share/nginx/html
```

Copy the `index.html` file.

```shell
kubectl cp /path/to/your/index.html some-nginx:/usr/share/nginx/html/index.html
```

Follow instructions in [Testing the web server](#testing-the-web-server-kubernetes), you should get back the content of your `index.html`.

## Testing the web server

### Accessing the web server from within the container

Attach to the webserver.

```shell
kubectl exec -it some-nginx -- bash
```

Install `curl`.

```
apt-get update && apt-get install -y curl
```

We can now use `curl` to see if the webserver returns content.

```
curl http://localhost
```

# Using Docker

Consult [Marketplace container documentation](https://cloud.google.com/marketplace/docs/container-images)
for additional information about setting up your Docker environment.

## Running Nginx

### Start a Nginx web server

Use the following content for the `docker-compose.yml` file, then run `docker-compose up`.

```yaml
version: '2'
services:
nginx:
container_name: some-nginx
image: marketplace.gcr.io/google/nginx1
ports:
- '80:80'
- '443:443'
```

Or you can use `docker run` directly:

```shell
docker run \
--name some-nginx \
-p 80:80 \
-p 443:443 \
-d \
marketplace.gcr.io/google/nginx1
```

For information about how to retain your data across restarts, see [Use a persistent data volume](#use-a-persistent-data-volume-docker).

For information about how to configure your web server, see [Web server configuration](#configuration-docker).

### Use a persistent data volume

To preserve your web server data when the container restarts, put
the web content directory on a persistent volume.

By default, `/usr/share/nginx/html` directory on the container houses all the web content files.

Also assume that `/my/persistent/dir/www` is the persistent directory on the host.

Use the following content for the `docker-compose.yml` file, then run `docker-compose up`.

```yaml
version: '2'
services:
nginx:
container_name: some-nginx
image: marketplace.gcr.io/google/nginx1
ports:
- '80:80'
- '443:443'
volumes:
- /my/persistent/dir/www:/usr/share/nginx/html
```

Or you can use `docker run` directly:

```shell
docker run \
--name some-nginx \
-p 80:80 \
-p 443:443 \
-v /my/persistent/dir/www:/usr/share/nginx/html \
-d \
marketplace.gcr.io/google/nginx1
```

The web server configuration should also be on a persistent volume. For more information, see [Web server configuration](#configuration-docker).

## Web server configuration

### Viewing existing configuration

Nginx configuration file is at `/etc/nginx/nginx.conf`.

```shell
docker exec some-nginx cat /etc/nginx/nginx.conf
```

### Using configuration volume

Use the following content for the `docker-compose.yml` file, then run `docker-compose up`.

```yaml
version: '2'
services:
nginx:
container_name: some-nginx
image: marketplace.gcr.io/google/nginx1
ports:
- '80:80'
- '443:443'
volumes:
- /path/to/your/site.conf:/etc/nginx/conf.d/site.conf
```

Or you can use `docker run` directly:

```shell
docker run \
--name some-nginx \
-p 80:80 \
-p 443:443 \
-v /path/to/your/site.conf:/etc/nginx/conf.d/site.conf \
-d \
marketplace.gcr.io/google/nginx1
```

### Moving the web content to Nginx

We can move the web content to the container with the commands below, assuming `/usr/share/nginx/html` is where nginx has been configured to read from.

Create the directory if it does not exist yet.

```shell
docker exec some-nginx mkdir -p /usr/share/nginx/html
```

Copy the `index.html` file.

```shell
docker cp /path/to/your/index.html some-nginx:/usr/share/nginx/html/index.html
```

Follow instructions in [Testing the web server](#testing-the-web-server-docker), you should get back the content of your `index.html`.

## Testing the web server

### Accessing the web server from within the container

Attach to the webserver.

```shell
docker exec -it some-nginx bash
```

Install `curl`.

```
apt-get update && apt-get install -y curl
```

We can now use `curl` to see if the webserver returns content.

```
curl http://localhost
```

# References

## Ports

These are the ports exposed by the container image.

| **Port** | **Description** |
|:---------|:----------------|
| TCP 80 | Nginx http default port |
| TCP 443 | Nginx https secure connection over SSL |
| TCP 9113 | Prometheus metrics exporter |

## Volumes

These are the filesystem paths used by the container image.

| **Path** | **Description** |
|:---------|:----------------|
| /etc/nginx | Contains nginx configuration files, including `nginx.conf`.

The default `nginx.conf` include all `.conf` files under the subdirectory `conf.d`. |