autogen: pin v0.7.0-alpha.0 release commit

ory · Oct 6, 2021 · 7962e77 · 7962e77
1 parent e995829
commit 7962e77
Show file tree

Hide file tree

Showing 20 changed files with 102 additions and 30 deletions.
diff --git a/docs/docs/contributing.md b/docs/docs/contributing.md
@@ -184,7 +184,7 @@ Pull requests eligible for review
 5. have signed our
    [Contributor License Agreement](https://cla-assistant.io/ory/keto);
 6. include a proper git commit message following the
-   [Conventional Commit Specification](https://www.conventionalcommits.org/en/v0.7.0-alpha.0.pre.5/).
+   [Conventional Commit Specification](https://www.conventionalcommits.org/en/v0.7.0-alpha.0/).
 
 If all of these items are checked, the pull request is ready to be reviewed and
 you should change the status to "Ready for review" and

diff --git a/docs/docs/guides/expand-api-display-who-has-access.mdx b/docs/docs/guides/expand-api-display-who-has-access.mdx
@@ -73,7 +73,7 @@ tree of everyone who has access to that file:
 
 <CodeTabs
   sampleId="expand-api-display-access/01-expand-beach"
-  version="v0.7.0-alpha.0.pre.5"
+  version="v0.7.0-alpha.0"
 />
 
 ### Maximum Tree Depth

diff --git a/docs/docs/guides/list-api-display-objects.mdx b/docs/docs/guides/list-api-display-objects.mdx
@@ -75,7 +75,7 @@ chats, the application uses Keto's list API:
 
 <CodeTabs
   sampleId="list-api-display-objects/01-list-PM"
-  version="v0.7.0-alpha.0.pre.5"
+  version="v0.7.0-alpha.0"
 />
 
 As a response, the application gets the list of all chats the user `PM` is a
@@ -101,7 +101,7 @@ In our example, a user wants to see who is a member of the `coffee-break` group:
 
 <CodeTabs
   sampleId="list-api-display-objects/02-list-coffee-break"
-  version="v0.7.0-alpha.0.pre.5"
+  version="v0.7.0-alpha.0"
 />
 
 ## Application Context

diff --git a/docs/docs/guides/simple-access-check-guide.mdx b/docs/docs/guides/simple-access-check-guide.mdx
@@ -81,15 +81,15 @@ Try this yourself by first adding the relation tuple using the
 
 <CodeTabs
   sampleId="simple-access-check-guide/00-write-direct-access"
-  version="v0.7.0-alpha.0.pre.5"
+  version="v0.7.0-alpha.0"
 />
 
 Now, we can use the check-API to verify that `john` is allowed to `decypher` the
 message:
 
 <CodeTabs
   sampleId="simple-access-check-guide/01-check-direct-access"
-  version="v0.7.0-alpha.0.pre.5"
+  version="v0.7.0-alpha.0"
 />
 
 ### Indirectly Defined Access

diff --git a/docs/docs/install.md b/docs/docs/install.md
@@ -11,8 +11,8 @@ binaries, Docker images, and support a number of package managers.
 We recommend using Docker to run Ory Keto:
 
 ```shell
-$ docker pull oryd/keto:v0.7.0-alpha.0.pre.5
-$ docker run --rm -it oryd/keto:v0.7.0-alpha.0.pre.5 help
+$ docker pull oryd/keto:v0.7.0-alpha.0
+$ docker run --rm -it oryd/keto:v0.7.0-alpha.0 help
 ```
 
 ## macOS
@@ -31,7 +31,7 @@ On linux, you can use `bash <(curl ...)` to fetch the latest stable binary
 using:
 
 ```shell
-$ bash <(curl https://raw.githubusercontent.com/ory/keto/master/install.sh) -b . v0.7.0-alpha.0.pre.5
+$ bash <(curl https://raw.githubusercontent.com/ory/keto/master/install.sh) -b . v0.7.0-alpha.0
 $ ./keto help
 ```
 
@@ -78,7 +78,7 @@ will only work with a Linux shell like bash or sh.
 ```shell
 $ git clone https://github.com/ory/keto.git
 $ cd keto
-$ git checkout v0.7.0-alpha.0.pre.5
+$ git checkout v0.7.0-alpha.0
 $ make install
 $ keto help
 ```
diff --git a/docs/docs/milestones.md b/docs/docs/milestones.md
@@ -3,7 +3,7 @@ id: milestones
 title: Milestones and Roadmap
 ---
 
-## [v0.7.0](https://github.com/ory/keto/milestone/5)
+## [v0.7.0-alpha.0](https://github.com/ory/keto/milestone/5)
 
 The biggest change for the next release will be the new SQL table structure
 (https://github.com/ory/keto/pull/638). The main goal is to improve the QoS, big

diff --git a/docs/docs/quickstart.mdx b/docs/docs/quickstart.mdx
@@ -66,7 +66,7 @@ video service client would do. In this example we will use the Keto CLI client.
 If you want to run the Keto CLI within **Docker**, set the alias
 
 ```shell
-alias keto="docker run -it --network cat-videos-example_default -e KETO_READ_REMOTE=\"keto:4466\" oryd/keto:v0.7.0-alpha.0.pre.5"
+alias keto="docker run -it --network cat-videos-example_default -e KETO_READ_REMOTE=\"keto:4466\" oryd/keto:v0.7.0-alpha.0"
 ```
 
 in your terminal session. Alternatively, you need to set the remote endpoint so

diff --git a/docs/docs/reference/configuration.md b/docs/docs/reference/configuration.md
@@ -723,7 +723,7 @@ namespaces: http://a.aaa
 # - Windows Command Line (CMD):
 #    > set VERSION=<value>
 #
-version: v0.0.0
+version: v0.7.0-alpha.0
 
 ## Data Source Name ##
 #

diff --git a/docs/package-lock.json b/docs/package-lock.json
diff --git a/docs/versioned_docs/version-v0.7/cli/keto-migrate-up.md b/docs/versioned_docs/version-v0.7/cli/keto-migrate-up.md
@@ -17,7 +17,7 @@ Migrate the database up
 ### Synopsis
 
 Run this command on a fresh SQL installation and when you upgrade Ory Keto from
-version v0.7.0-alpha.0.pre.5 and later.
+version v0.7.x and later.
 
 It is recommended to run this command close to the SQL instance (e.g. same
 subnet) instead of over the public internet. This decreases risk of failure and

diff --git a/docs/versioned_docs/version-v0.7/contributing.md b/docs/versioned_docs/version-v0.7/contributing.md
@@ -184,7 +184,7 @@ Pull requests eligible for review
 5. have signed our
    [Contributor License Agreement](https://cla-assistant.io/ory/keto);
 6. include a proper git commit message following the
-   [Conventional Commit Specification](https://www.conventionalcommits.org/en/v0.7.0-alpha.0.pre.5/).
+   [Conventional Commit Specification](https://www.conventionalcommits.org/en/v0.7.0-alpha.0/).
 
 If all of these items are checked, the pull request is ready to be reviewed and
 you should change the status to "Ready for review" and

diff --git a/docs/versioned_docs/version-v0.7/guides/expand-api-display-who-has-access.mdx b/docs/versioned_docs/version-v0.7/guides/expand-api-display-who-has-access.mdx
@@ -73,7 +73,7 @@ tree of everyone who has access to that file:
 
 <CodeTabs
   sampleId="expand-api-display-access/01-expand-beach"
-  version="v0.7.0-alpha.0.pre.5"
+  version="v0.7.0-alpha.0"
 />
 
 ### Maximum Tree Depth

diff --git a/docs/versioned_docs/version-v0.7/guides/list-api-display-objects.mdx b/docs/versioned_docs/version-v0.7/guides/list-api-display-objects.mdx
@@ -75,7 +75,7 @@ chats, the application uses Keto's list API:
 
 <CodeTabs
   sampleId="list-api-display-objects/01-list-PM"
-  version="v0.7.0-alpha.0.pre.5"
+  version="v0.7.0-alpha.0"
 />
 
 As a response, the application gets the list of all chats the user `PM` is a
@@ -101,7 +101,7 @@ In our example, a user wants to see who is a member of the `coffee-break` group:
 
 <CodeTabs
   sampleId="list-api-display-objects/02-list-coffee-break"
-  version="v0.7.0-alpha.0.pre.5"
+  version="v0.7.0-alpha.0"
 />
 
 ## Application Context

diff --git a/docs/versioned_docs/version-v0.7/guides/simple-access-check-guide.mdx b/docs/versioned_docs/version-v0.7/guides/simple-access-check-guide.mdx
@@ -81,15 +81,15 @@ Try this yourself by first adding the relation tuple using the
 
 <CodeTabs
   sampleId="simple-access-check-guide/00-write-direct-access"
-  version="v0.7.0-alpha.0.pre.5"
+  version="v0.7.0-alpha.0"
 />
 
 Now, we can use the check-API to verify that `john` is allowed to `decypher` the
 message:
 
 <CodeTabs
   sampleId="simple-access-check-guide/01-check-direct-access"
-  version="v0.7.0-alpha.0.pre.5"
+  version="v0.7.0-alpha.0"
 />
 
 ### Indirectly Defined Access

diff --git a/docs/versioned_docs/version-v0.7/guides/v0.7-migration.mdx b/docs/versioned_docs/version-v0.7/guides/v0.7-migration.mdx
@@ -0,0 +1,57 @@
+---
+title: Migrating to Keto v0.7
+---
+
+Ory Keto v0.6 used the table-separated namespaces database schema described in
+the [Google Zanzibar paper](https://research.google/pubs/pub48190/). However, we
+found for various reasons outlined in
+[#613](https://github.com/ory/keto/issues/613) that this is not ideal for Keto.
+
+Because the database schema changed significantly, and it is not possible to
+have SQL-only migrations, there is a special migration procedure needed to
+upgrade Ory Keto v0.6.
+
+## Preparations
+
+:::danger
+
+As always with database migrations, please make a backup of your data and try
+the migration process first on a non-production copy of the database.
+
+:::
+
+This migration has to download all the data from the database, transform them,
+and then write them back to the database. Make sure that you run it as close to
+the database as possible to reduce the latency and failure rate. In case of a
+failure, just restart the process. It is run as one big SQL transaction.
+
+## Recommended Procedure
+
+:::caution
+
+This is the **recommended** procedure. Please adjust to your setup and **test**
+before applying to a production system. You might want to create a migration
+script that applies all these steps and handles errors.
+
+:::
+
+This procedure is zero-downtime only for read API requests. The write API will
+not be available during migration.
+
+1. Create a new database user (from now on `keto_new`) with the same privileges
+   as the one used until now (let's say it was `keto`).
+2. Start a server instance of Keto v0.7 next to the already running Keto v0.6.
+   It should have the same settings, but use `keto_new` for accessing the
+   database.
+3. Change the privileges of `keto` to be read-only on all tables.
+4. Still route all traffic to the old Keto. Write API requests will fail from
+   now on, but the Read API will be zero-downtime.
+5. Run `keto namespace migrate legacy --yes` considering the points raised in
+   [preparations](#preparations).
+6. In case of failure, re-run the command until it succeeds.
+7. In case of log statements stating
+   `Skipping relation tuple, it seems to be in a broken state. Please recreate it manually.`
+   note down the logged data somewhere and recreate the relation tuples in
+   question once the migration is done using the API.
+8. After the migration is successfully done, route all traffic to Keto v0.7 and
+   shut down Keto v0.6. At this point the API is fully operational again.
diff --git a/docs/versioned_docs/version-v0.7/install.md b/docs/versioned_docs/version-v0.7/install.md
@@ -11,8 +11,8 @@ binaries, Docker images, and support a number of package managers.
 We recommend using Docker to run Ory Keto:
 
 ```shell
-$ docker pull oryd/keto:v0.7.0-alpha.0.pre.5
-$ docker run --rm -it oryd/keto:v0.7.0-alpha.0.pre.5 help
+$ docker pull oryd/keto:v0.7.0-alpha.0
+$ docker run --rm -it oryd/keto:v0.7.0-alpha.0 help
 ```
 
 ## macOS
@@ -31,7 +31,7 @@ On linux, you can use `bash <(curl ...)` to fetch the latest stable binary
 using:
 
 ```shell
-$ bash <(curl https://raw.githubusercontent.com/ory/keto/master/install.sh) -b . v0.7.0-alpha.0.pre.5
+$ bash <(curl https://raw.githubusercontent.com/ory/keto/master/install.sh) -b . v0.7.0-alpha.0
 $ ./keto help
 ```
 
@@ -78,7 +78,7 @@ will only work with a Linux shell like bash or sh.
 ```shell
 $ git clone https://github.com/ory/keto.git
 $ cd keto
-$ git checkout v0.7.0-alpha.0.pre.5
+$ git checkout v0.7.0-alpha.0
 $ make install
 $ keto help
 ```
diff --git a/docs/versioned_docs/version-v0.7/milestones.md b/docs/versioned_docs/version-v0.7/milestones.md
@@ -3,7 +3,7 @@ id: milestones
 title: Milestones and Roadmap
 ---
 
-## [v0.7.0-alpha.0.pre.5](https://github.com/ory/keto/milestone/5)
+## [v0.7.0-alpha.0](https://github.com/ory/keto/milestone/5)
 
 The biggest change for the next release will be the new SQL table structure
 (https://github.com/ory/keto/pull/638). The main goal is to improve the QoS, big
@@ -53,11 +53,11 @@ Affects documentation.
 
 #### Issues
 
-- [ ] Guide for data migration to new single table schema
-      ([keto#733](https://github.com/ory/keto/issues/733)) -
-      [@Patrik](https://github.com/zepatrik)
 - [x] Document and improve go gRPC client import
       ([keto#635](https://github.com/ory/keto/issues/635))
+- [x] Guide for data migration to new single table schema
+      ([keto#733](https://github.com/ory/keto/issues/733)) -
+      [@Patrik](https://github.com/zepatrik)
 
 ### [Ci](https://github.com/ory/keto/labels/ci)
 

diff --git a/docs/versioned_docs/version-v0.7/quickstart.mdx b/docs/versioned_docs/version-v0.7/quickstart.mdx
@@ -66,7 +66,7 @@ video service client would do. In this example we will use the Keto CLI client.
 If you want to run the Keto CLI within **Docker**, set the alias
 
 ```shell
-alias keto="docker run -it --network cat-videos-example_default -e KETO_READ_REMOTE=\"keto:4466\" oryd/keto:v0.7.0-alpha.0.pre.5"
+alias keto="docker run -it --network cat-videos-example_default -e KETO_READ_REMOTE=\"keto:4466\" oryd/keto:v0.7.0-alpha.0"
 ```
 
 in your terminal session. Alternatively, you need to set the remote endpoint so

diff --git a/docs/versioned_docs/version-v0.7/reference/configuration.md b/docs/versioned_docs/version-v0.7/reference/configuration.md
@@ -723,7 +723,7 @@ namespaces: http://a.aaa
 # - Windows Command Line (CMD):
 #    > set VERSION=<value>
 #
-version: v0.7.0-alpha.0.pre.5
+version: v0.7.0-alpha.0
 
 ## Data Source Name ##
 #

diff --git a/docs/versioned_sidebars/version-v0.7-sidebars.json b/docs/versioned_sidebars/version-v0.7-sidebars.json
@@ -251,11 +251,21 @@
           "type": "link",
           "href": "https://www.ory.sh/docs/ecosystem/configuring"
         },
+        {
+          "label": "Deployment Fundamentals and Requirements",
+          "type": "link",
+          "href": "https://www.ory.sh/docs/ecosystem/deployment"
+        },
         {
           "label": "Software Updates",
           "type": "link",
           "href": "https://www.ory.sh/docs/ecosystem/upgrading"
         },
+        {
+          "label": "Logs and Audit Trails",
+          "type": "link",
+          "href": "https://www.ory.sh/docs/ecosystem/logging"
+        },
         {
           "label": "Contributing",
           "type": "link",
@@ -887,6 +897,10 @@
               "type": "doc",
               "id": "version-v0.7/guides/production"
             },
+            {
+              "type": "doc",
+              "id": "version-v0.7/guides/v0.7-migration"
+            },
             {
               "type": "doc",
               "id": "version-v0.7/guides/rbac"