Policy development tutorial #1204
Conversation
| ### prerequisites | ||
| This means both Docker and Docker compose must be installed. | ||
|
|
||
| The version of Docker I currently use is: |
There was a problem hiding this comment.
You can remove this line ☝️
|
|
||
| Instructions for installing Docker can be found on the Docker [website](https://docs.docker.com/get-docker/). | ||
|
|
||
| With Docker compose version: |
There was a problem hiding this comment.
You can remove this line
|
|
||
| Docker version 19.03.8 | ||
|
|
||
| Instructions for installing Docker can be found on the Docker [website](https://docs.docker.com/get-docker/). |
There was a problem hiding this comment.
You can remove this line
| make development | ||
| ``` | ||
|
|
||
|  |
There was a problem hiding this comment.
Is this image essential to provide a clear understanding of the configuration process?
- If
yes, please include a paragraph explaining the image. - If
no, you can remove the image.
There was a problem hiding this comment.
leaving the image as it is. It does not need further explanation. It gives a clear understanding of what it does. At least, for those familiar with docker and docker-compose (which is a requisite for any APIcast contributor)
I would not add an image, instead I would copy those lines in a code block. But good enough
There was a problem hiding this comment.
I have replaced the image with the text
|
|
||
| The Docker container starts in the foreground with a bash session. The first thing we need to do inside the container is installing all the dependencies. | ||
|
|
||
| This can also be done using a Make command, which again must be issued **inside** the container. |
There was a problem hiding this comment.
You can remove this line.
| ```shell | ||
| make dependencies | ||
| ``` | ||
| It will now download and install a plethora of dependencies inside the container. |
|
|
||
| The output will be very long, but if everything went well you should be greeted with an output that looks something like this: | ||
|
|
||
|  |
There was a problem hiding this comment.
Can you replace the image with the text that the user will see?
|
|
||
|  | ||
|
|
||
| Now as a final verification we can run some APIcast unit tests to see if we are up and running and ready to start the development of our policy. |
There was a problem hiding this comment.
Does "as a final verification" refer to a confirmation step related to the installation of the dependencies inside the container? If 'yes`, please reword this sentence to remove the mentioned phrase, because the general policy configuration is still in progress.
Thanks @porueesq for taking the time and effort to review the Pull Request. I'll have a look at your comments and suggestions. |
Co-authored-by: porueesq <[email protected]>
| Now in order to start the APIcast server with the hello_world_configuration.json file inside the development container issue the following command: | ||
|
|
||
| ```shell | ||
| bash-4.2$ bin/apicast --log-level=debug --dev -c examples/configuration/hello_world_config.json |
There was a problem hiding this comment.
I will suggest to use the following:
THREESCALE_CONFIG_FILE=hello_world_config.json APICAST_LOG_LEVEL=debug ./bin/apicast
The main reason is how the people will use env variables, so things are easy to test in that way.
|
is this PR ready for review before merge? |
|
please rebase on top of the current master branch head |
|
@pimg apologies for the huge delay in reviewing this but are you able to rebase onto master so we can mere this finally? |
A tutorial to introduce people to the world of policy development.