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

Quickstart is outdated #1516

Open
3 of 5 tasks
alfa-alex opened this issue Mar 18, 2024 · 1 comment
Open
3 of 5 tasks

Quickstart is outdated #1516

alfa-alex opened this issue Mar 18, 2024 · 1 comment
Labels
feat New feature or request.

Comments

@alfa-alex
Copy link

Preflight checklist

Ory Network Project

No response

Describe your problem

The Keto Quickstart is based on keto v0.7.0-alpha.1. This is confusing because the instance started by this is not consistent with the API docs that assume the latest keto version (for example, regarding the handling of a non-set max_depth). Updating the version yourself easily is made difficult by the following factors:

  • the Docker image used in the docker-compose of the cat-videos-example has a -sqlite suffix; on Dockerhub there is no no -sqlite version later than v0.8.0
  • even for non--sqlite versions the latest Dockerhub-published version is v0.12.0 whereas the latest release is v0.13.0 (means you don't automatically publish a new docker image with every release)
  • the contrib folder hasn't been updated for a while: the relation-tuples/*.json contain a "$schema": "../../../.schema/relation_tuple.schema.json", line that doesn't seem to be supported by more recent version of keto (if I am mistaken, please answer here and I'll update this issue accordingly)
  • the docker-compose.yml's init container command lacks the --insecure-disable-transport-security=true argument that is required in newer versions of the keto CLI (same holds true for all the CLI commands mentioned in the Quickstart).

After some research I could find out that I can actually use the project's Dockerfile-build via the build make target and just needed to update the folders in the docker-compose.yaml from /home/ory to /home/nonroot. Putting together all these pieces I was able to run a current version of keto via docker.

It would be nice if you could update both the examples and the Quickstart guide. In any case, I hope this issue might help other newcomers who run into the same problems when trying to run a recent version of keto.

Describe your ideal solution

  • Quickstart is updated to the latest keto version
  • docker hub images are kept up-to-date with new releases

Workarounds or alternatives

Does not apply.

Version

v0.13.0

Additional Context

No response

@alfa-alex alfa-alex added the feat New feature or request. label Mar 18, 2024
@nmapx
Copy link

nmapx commented Mar 27, 2024

I have the same feeling about keto. Once you get started with Hydra/Kratos it's much easier to add other products like Keto and Oathkeeper to the stack. But starting with Keto and outdated documentation might be a problem for less experienced developers.
Docker images are usually released right away (was never a problem for me) but indeed v0.13 was published already but the image in registry is missing. The whole topic of Keto releases should be discussed since it's in alpha for a long time now and what is the future of this project in overall in that case?

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

No branches or pull requests

2 participants