Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Gh-24: Integrate any documentation into the Gaffer-Doc project #324

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@
Gaffer Docker
================
# Gaffer Docker

This repo contains the code needed to run Gaffer using Docker or Kubernetes.
This repo contains the code needed to run Gaffer using Docker or Kubernetes.
There are two main sub-folders, 'docker' and 'kubernetes' which contain the project files you need for starting Gaffer using those services.

# Running Gaffer Using Docker
For information on how to run Gaffer using Docker containers, please see the README in the docker directory: [Gaffer Docker README](docker/README.md)

For information on how to run Gaffer using Docker containers, please see the documentation: [Gaffer Docker Docs](https://gchq.github.io/gaffer-doc/latest/dev/docker/)

# Running Gaffer Using Kubernetes
For information on how to run Gaffer using Kubernetes, please see the README in the kubernetes directory: [Kubernetes README](kubernetes/README.md)

For information on how to run Gaffer using Kubernetes, please see the documentation: [Gaffer Kubernetes Docs](https://gchq.github.io/gaffer-doc/latest/dev/kubernetes-guide/kubernetes/)

# Versioning

Each of our images which is released will be tagged with the version of the software they represent. Every release,
we update the `latest` tag for each image and add a new release which has the corresponding version tag.

If we release Gaffer version 2.1.2, the following images would be uploaded:

* gchq/gaffer:latest
* gchq/gaffer:2
* gchq/gaffer:2.1
* gchq/gaffer:2.1.2
* gchq/gaffer:2.1.2-accumulo-2.0.1
- gchq/gaffer:latest
- gchq/gaffer:2
- gchq/gaffer:2.1
- gchq/gaffer:2.1.2
- gchq/gaffer:2.1.2-accumulo-2.0.1

We maintain mutable versions of latest, as well as the major, minor and bugfix versions of Gaffer. For reproducibility
make sure to use the full version in your build metadata. For `gaffer`/`gaffer-rest` images, we also create a tag including the
Expand All @@ -30,7 +32,9 @@ are not published but can be build locally if required.
The release process is automated by GitHub actions.

# Known Compatible Docker Versions
* 20.10.23

- 20.10.23

# Contributing

If you would like to make a Contribution, we have all the details for doing that [here](CONTRIBUTING.md)
21 changes: 0 additions & 21 deletions docker/README.md

This file was deleted.

28 changes: 0 additions & 28 deletions kubernetes/README.md

This file was deleted.

48 changes: 0 additions & 48 deletions kubernetes/accumulo/docs/kind-deployment.md

This file was deleted.

63 changes: 0 additions & 63 deletions kubernetes/docs/add-libraries.md

This file was deleted.

156 changes: 0 additions & 156 deletions kubernetes/docs/aws-eks-deployment.md

This file was deleted.

Loading
Loading