jakub-gawlas / lorem-docu

Example docker image with documentation + k8s configs

Lorem docu

Generating and delivering content with using Content Generator and Content Deliverer.

Run

docker run --rm -it -p 3000:3000 jakubgawlas/lorem-docu

Application is running on localhost:3000.

Available endpoints:

• GraphQL IDE (/graphiql)
• GraphQL endpoint (/graphql), for example http://localhost:3000/graphql?query={documentation{name%20description%20documents{title%20tags%20content}}}
• Resources (/files/:filename)

Build

Files required to generate documentation are placed in src dir:

• configuration file docu.config.json
• docu dir, which contains sources of content to generate

docker build --build-arg RESOURCES_BASE_URI={{URI}} -t my-docu .

• {{URI}} base URI where resources will be served (default: localhost:3000/files)

Deploy on Kubernetes

1. Deployment

kubectl create -f kubernetes/deployment.yaml

2. Service

kubectl create -f kubernetes/service.yaml

3. Ingress

kubectl create -f kubernetes/ingress.yaml