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

Dockerize me and set me up for wider adoption #38

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

nkammah
Copy link

@nkammah nkammah commented Oct 2, 2022

This PR introduces a dockerized version of Zat, and a detailed installation guide for folks who may not have a full dev. environment setup.

Notes:

  • It seems like Docker Desktop uses port 8080, so I had to use a different one to redirect requests from Zat to the host - I picked 8060
  • For the launchctl configuration, while storing configs in /usr/local/etc/zat/ was really appealing, DockerDesktop, at least on mac, does not allow that location by default - so I picked $HOME/.zatconfig instead
  • In this PR, I pushed the repo to my namespace in the Elastic container registry, but we can and should totally move it to your namespace Gil
  • It would be very interesting to find a flow to share (maybe via vault or pastebin on demand) the Zat Slack app credentials

Comment on lines +6 to +21

## Pre-requisites

We'll be using the Terminal app to run commands.
You can already launch it by hitting the `command+space` keys then searching for `terminal`.

### Install Docker and configure it

1. Download and install [Docker Desktop](https://docs.docker.com/desktop/install/mac-install/) for Mac.
You'll get a warning saying that Docker Desktop needs privileged access - you will need to enter your computer password when prompted.
You'll see a "Docker Subscription Service Agreement" screen - accept it.

2. Start Docker and create an account
Open the Docker app, and follow the steps to create an account.


Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Pre-requisites
We'll be using the Terminal app to run commands.
You can already launch it by hitting the `command+space` keys then searching for `terminal`.
### Install Docker and configure it
1. Download and install [Docker Desktop](https://docs.docker.com/desktop/install/mac-install/) for Mac.
You'll get a warning saying that Docker Desktop needs privileged access - you will need to enter your computer password when prompted.
You'll see a "Docker Subscription Service Agreement" screen - accept it.
2. Start Docker and create an account
Open the Docker app, and follow the steps to create an account.

This is not zat specific so I'd prefer we just remove it altogether

Comment on lines +22 to +33
### Log into Elastic container registry

We're now going to log into Elastic container registry, where we'll download zat.
Visit [https://docker-auth.elastic.co](https://docker-auth.elastic.co) - click on the `Login to @elastic with GitHub` button.
You may get redirect to an Okta log-in screen, but eventually will see a page as below:

![Container Registry Login](img/container_registry_loging.png)


Copy the full line, after the `$` sign and paste it into the Terminal window and press enter.
You should see a `Login Succeeded` message.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Log into Elastic container registry
We're now going to log into Elastic container registry, where we'll download zat.
Visit [https://docker-auth.elastic.co](https://docker-auth.elastic.co) - click on the `Login to @elastic with GitHub` button.
You may get redirect to an Okta log-in screen, but eventually will see a page as below:
![Container Registry Login](img/container_registry_loging.png)
Copy the full line, after the `$` sign and paste it into the Terminal window and press enter.
You should see a `Login Succeeded` message.

This is a high barrier too, why not just docker hub since this is all public anyway?

4. Verify that it loaded correctly
```
tail /tmp/zat.log
```
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lots of overlap here with the README but these are excellent and I love the screenshots - I'd be happy to merge this in and consolidate the two docs in a follow up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants