Skip to content

Commit

Permalink
incorporate Julia's edits
Browse files Browse the repository at this point in the history
  • Loading branch information
antonovchtd committed Nov 18, 2022
1 parent 3cefc55 commit 107ebc4
Showing 1 changed file with 13 additions and 20 deletions.
33 changes: 13 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@ By default, the image is pulled from [WebSpellChecker Docker Hub](https://hub.do
however, many users would require building their own local images with custom configuration.
Please refer to [our other repository](https://github.com/WebSpellChecker/wproofreader-docker/) to get started with building your own docker image.

## Pre-requisites
## Prerequisites

To deploy WProofreader service on a Kubernetes cluster, a machine with
`kubectl` tool configured to communicate with your cluster, see [here](https://kubernetes.io/docs/tasks/tools/), and
Helm executable itself is required (see [here](https://helm.sh/docs/intro/quickstart/#install-helm)).
Before you begin, make sure you have the required environment:

- Kubernetes command-line tool, [kubectl](https://kubernetes.io/docs/reference/kubectl/kubectl/)
- [Helm](https://helm.sh/docs/intro/quickstart/#install-helm), the package manager for Kubernetes

## Basic installation

Expand Down Expand Up @@ -65,12 +66,7 @@ There are three ways the service can be activated:
```
provided that `LICENSE_TICKET_ID` is set in your environment.

IMPORTANT: unactivated images (e.g. those from WebSpellChecker Docker Hub)
will require new activation each time the container is started. Due to the limit
on activation attempts for each license (25 by default), it might fail eventually
and one would have to contact WebSpellChecker Support Team for a reset.
It is therefore not recommended to use unactivated images with License ID CLI flags
for production, only for testing, development, and evaluation purposes.
IMPORTANT! If you are attempting to build a production environment, it's recommended to use the custom Docker image with WProofreader Server instead of the public one published on Docker Hub. With the custom image, you won't need to activate the license on the container start. Thus, you just skip this step. Otherwise, you may face the issue with reaching the maximum allowed number of license activation attempts (by default, 25). In this case, you need to [contact support](https://webspellchecker.com/contact-us/) to extend/reset the license activation limit. Nevertheless, using the public image is acceptable for evaluation, testing and development purposes.

## HTTPS

Expand Down Expand Up @@ -140,11 +136,10 @@ Please make sure that all values arguments passed as `--set` CLI arguments
were duplicated with your latest `helm upgrade` call, or simply use `--reuse-values` flag.
Otherwise, they are overwritten with the contents of `values.yaml`.

## Example manifests
## Sample Kubernetes manifests

For illustration purposes, Kubernetes manifests generated by Helm
(with Helm labels removed) are provided in the `manifests` folder.
The generator command used was:
For illustration purposes, please find exported Kubernetes manifests in the `manifests` folder.
If you need to export the manifest files from this sample Helm Chart, please use the following command:
```shell
helm template --namespace wsc wsc-app-sample wproofreader \
--set licenseTicketID=qWeRtY123 \
Expand All @@ -157,19 +152,17 @@ helm template --namespace wsc wsc-app-sample wproofreader \

## Troubleshooting

A service might fail to start up properly if misconfigured. For troubleshooting,
it could be beneficial to get the full configuration that was attempted to be deployed,
which later can be studied or shared with a developer or WebSpellChecker Support Team.
The service might fail to start up properly if misconfigured. For troubleshooting, it can be beneficial to get the full configuration you attempted to deploy. If needed, later it can be shared with the support team for further investigation.

There are two ways one could go about achieving this. First would be to query
the values (user-configurable options) that Helm uses to generate Kubernetes manifests:
There are several options for how to gather needed details:
1. Get the values (user-configurable options) used by Help to generate Kubernetes manifests:
```shell
helm get values --all --namespace wsc wsc-app-5-25-0 > wsc-app-5-25-0-values.yaml
```
where `wsc` is the namespace and `wsc-app-5-25-0` – the name of your release,
and `wsc-app-5-25-0-values.yaml` – name of the file the data will be written to.

Second option is to get the full Kubernetes manifests themselves. Similarly:
Extract the full Kubernetes manifest(s) as follows:
```shell
helm get manifest --namespace wsc wsc-app-5-25-0 > manifests.yaml
```
Expand Down

0 comments on commit 107ebc4

Please sign in to comment.