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

docs: Docker image documentation #573

Merged
merged 6 commits into from Jul 14, 2020
Merged

docs: Docker image documentation #573

merged 6 commits into from Jul 14, 2020

Conversation

tricky42
Copy link
Contributor

Proposed changes

As the official Docker images provided by Ory are the recommend way to run Kratos, we should provide more details on the different image types and how the images can be used.

This is only

Checklist

  • I have read the contributing guidelines.
  • I have read the security policy.
  • I confirm that this pull request does not address a security
    vulnerability. If this pull request addresses a security. vulnerability, I
    confirm that I got green light (please contact
    security@ory.sh) from the maintainers to push
    the changes.
  • I have added tests that prove my fix is effective or that my feature
    works.
  • I have added or changed the documentation.

@tricky42 tricky42 changed the title Docker image documentation docs: Docker image documentation Jul 13, 2020
FROM oryd/kratos:latest
COPY contrib/quickstart/kratos/email-password/.kratos.yml /ory/home
```

Copy link
Member

Choose a reason for hiding this comment

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

I would add a warning here that it's not good practice to copy config into docker images but that it's a good and dirty workaround to get started

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In my opinion unless we are talking about secrets or environment specific configuration the config can be part of Docker image. Normally you would add it as part of the last fs layer.

This allows to propagate the Docker image with the base configuration from env to env. But this is only how we handled it at work. Feedback welcome @kevgo @k9ert

docs/docs/guides/docker.md Outdated Show resolved Hide resolved
docs/docs/guides/docker.md Show resolved Hide resolved
docs/docs/guides/docker.md Outdated Show resolved Hide resolved
docs/docs/guides/docker.md Show resolved Hide resolved
docs/docs/guides/docker.md Show resolved Hide resolved
tricky42 and others added 3 commits July 13, 2020 16:11
Co-authored-by: hackerman <3372410+aeneasr@users.noreply.github.com>
Co-authored-by: hackerman <3372410+aeneasr@users.noreply.github.com>
Co-authored-by: hackerman <3372410+aeneasr@users.noreply.github.com>
@aeneasr
Copy link
Member

aeneasr commented Jul 14, 2020

🎉

@aeneasr aeneasr merged commit bfe032e into ory:master Jul 14, 2020
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.

None yet

2 participants