You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -2,22 +2,20 @@
2
2
3
3
The GeoLambda project provides public Docker images and AWS Lambda Layers containing common geospatial native libraries. GeoLambda contains the libraries PROJ.5, GEOS, GeoTIFF, HDF4/5, SZIP, NetCDF, OpenJPEG, WEBP, ZSTD, and GDAL. For some applications you may wish to minimize the size of the libraries by excluding unused libraries, or you may wish to add other libraries. In this case this repository can be used as a template to create your own Docker image or Lambda Layer following the instructions in this README.
4
4
5
-
This repository also contains examples and pre-built images for specific runtimes.
5
+
This repository also contains additional images and layers for specific runtimes. Using them as a Layer assumes the use of the basee GeoLambda layer.
6
6
7
7
-[Python](python/README.md)
8
8
9
9
## Usage
10
10
11
-
While GeoLambda was initially intended for AWS Lambda they are also useful as base geospatial Docker images. The version of GDAL included for different versions of GeoLambda is shown here:
11
+
While GeoLambda was initially intended for AWS Lambda it is also useful as a base geospatial Docker image. For detailed info on what is included in each image, see the Dockerfile for that version or the [CHANGELOG](CHANGELOG.md). A version summary is provided here:
12
12
13
13
| geolambda | GDAL | Notes |
14
14
| --------- | ---- ||
15
15
| 1.0.0 | 2.3.1 ||
16
16
| 1.1.0 | 2.4.1 ||
17
17
| 1.2.0 | 2.4.2 | Separate Python (3.7.4) image and Lambda Layer added |
18
18
19
-
To get the version numbers of all installed packages see the [CHANGELOG](CHANGELOG.md) or the Dockerfile for the specific version.
20
-
21
19
### Docker images
22
20
23
21
The Docker images used to create the Lambda layer are also published to Docker Hub, and thus are also suitable for general use as a base image for geospatial applications.
@@ -29,16 +27,18 @@ The developmentseed/geolambda image in Docker Hub is tagged by version.
29
27
Or just include it in your own Dockerfile as the base image.
30
28
31
29
```
32
-
FROM developmentseed/geolambda:${VERSION}
30
+
FROM developmentseed/geolambda:<version>
33
31
```
34
32
35
33
The GeoLambda image does not have an entrypoint defined, so a command must be provided when you run it. This example will mount the current directory to /work and run the container interactively.
36
34
37
35
$ docker run --rm -v $PWD:/home/geolambda -it developmentseed/geolambda:latest /bin/bash
38
36
37
+
All of the GDAL CLI tools are installed so could be run on images in the current directory.
38
+
39
39
### Lambda Layer
40
40
41
-
If you just wish to use the publicly available Lambda layer you will need the ARN for the layer in same region as your Lambda function. Currently, GeoLambda layers are available in `us-east-1`, `us-west-2`, and `eu-central-1`. If you want to use it in another region please file an issue or you can also create your own layer using this repository (see instructions below on 'Create a new version').
41
+
If you just wish to use the publicly available Lambda layer you will need the ARN for the layer in the same region as your Lambda function. Currently, GeoLambda layers are available in `us-east-1`, `us-west-2`, and `eu-central-1`. If you want to use it in another region please file an issue or you can also create your own layer using this repository (see instructions below on 'Create a new version').
42
42
43
43
#### v1.2.0
44
44
@@ -69,15 +69,15 @@ See the [GeoLambda Python README](python/README.md). The Python Lambda Layer inc
69
69
70
70
## Development
71
71
72
-
Contributions to the geolambda project are encouraged. The goal is to provide a turnkey method for developing and deploying geospatial Python based projects to Amazon Web Services. The 'master' branch in this repository contains the current state as deployed to the `developmentseed/geolambda:latest`image on Dockerhub, along with a tag of the version. The 'develop' branch is the development version and is not deployed to Dockerhub.
72
+
Contributions to the geolambda project are encouraged. The goal is to provide a turnkey method for developing and deploying geospatial applications to AWS. The 'master' branch in this repository contains the current state as deployed to the Docker Hub images `developmentseed/geolambda:latest`and `devlopmentseed/geolambda-python:latest`, along with a tag of the version. The 'develop' branch is the development version and is not deployed to Docker Hub.
73
73
74
-
When making a merge to the `master` branch be sure to increment the `VERSION`in the CircleCI config.yml file. Circle will push the new version as a tag to GitHub and build and push the image to Docker Hub. If a GitHub tag already exists with that version the process will fail.
74
+
When making a merge to the `master` branch be sure to increment the `VERSION` file. Circle will push the new version as a tag to GitHub and build and push the image to Docker Hub. If a GitHub tag already exists with that version the process will fail.
75
75
76
76
### Create a new version
77
77
78
78
Use the Dockerfile here as a template for your own version of GeoLambda. Simply edit it to remove or add additional libraries, then build and tag with your own name. The steps below are used to create a new official version of GeoLambda, replace `developmentseed/geolambda` with your own name.
79
79
80
-
To create a new version of GeoLambda follow these steps.
80
+
To create a new version of GeoLambda follow these steps. Note that this is the manual process of what is currently done in CircleCI, so it is not necessary to perform them but they are useful as an example for deploying your own versions.
0 commit comments