Merge pull request #101 from aserto-dev/upd-topaz-31-cli

upd topaz 31 cli
aserto-dev · Feb 23, 2024 · 78d0908 · 78d0908
2 parents 17260d0 + c3ca927
commit 78d0908
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 14 deletions.
diff --git a/docs/command-line-interface/policy-cli/download.mdx b/docs/command-line-interface/policy-cli/download.mdx
@@ -14,18 +14,25 @@ description: How to download and install the policy CLI
 These are available as tarballs in the [release](https://github.com/opcr-io/policy/releases) page.
 :::
 
-## Homebrew
+## Homebrew (macOS & Linux)
 
 You can install `policy` via homebrew for macOS or LinuxBrew for Linux:
 
 ```shell
 brew install opcr-io/tap/policy
 ```
 
+## WinGet (Windows)
+
+You can install the `policy` via WinGet on Windows 10+:
+```shell
+winget install OpenPolicyContainers.Policy
+```
+
 ## Go
 
 You can get `policy` via a GO install
 
 ```shell
-go get -u github.com/opcr-io/policy
+go install github.com/opcr-io/policy/cmd/policy@latest
 ```
diff --git a/docs/command-line-interface/topaz-cli/index.mdx b/docs/command-line-interface/topaz-cli/index.mdx
@@ -10,6 +10,11 @@
   brew tap aserto-dev/tap && brew install aserto-dev/tap/topaz
    ```
 
+* Via WinGet for Windows 10+
+   ```shell
+  winget install Aserto.Topaz
+   ```
+
 * On Windows 10+
 
   Download the `topaz_windows_x86_64.msi` file from the [GitHub releases page](https://github.com/aserto-dev/topaz/releases) and execute the MSI.
@@ -44,8 +49,6 @@ Commands:
   certs        cert commands
   update       update topaz container version
   uninstall    uninstall topaz container
-  load         load manifest from file (DEPRECATED)
-  save         save manifest to file (DEPRECATED)
   version      version information
 
 Flags:

diff --git a/docs/command-line-interface/topaz-cli/templates.mdx b/docs/command-line-interface/topaz-cli/templates.mdx
@@ -16,10 +16,13 @@ Example:
 ```shell
 topaz templates list
 
-  NAME          DESCRIPTION                            DOCUMENTATION
-  todo          Todo application end-to-end sample     https://docs.aserto.com/docs/quickstarts/todo/overview
-  simple-rbac   Simple RBAC authorization template
-  peoplefinder  Corporate directory end-to-end sample  https://docs.aserto.com/docs/getting-started/peoplefinder/peoplefinder-overview
+  NAME          DESCRIPTION                                                        DOCUMENTATION                                                                    
+  peoplefinder  Corporate directory end-to-end sample                              https://docs.aserto.com/docs/getting-started/peoplefinder/peoplefinder-overview  
+  todo          Todo application end-to-end sample                                 https://docs.aserto.com/docs/quickstarts/todo/overview                           
+  simple-rbac   Simple RBAC authorization template                                 https://docs.aserto.com/docs/quickstarts/simple-rbac/overview                    
+  gdrive        Authorization template for nested folders and documents            https://docs.aserto.com/docs/quickstarts/gdrive/overview                         
+  slack         Authorization template for workspaces and channels                 https://docs.aserto.com/docs/quickstarts/slack/overview                          
+  github        Authorization template for repositories, organizations and teams.  https://docs.aserto.com/docs/quickstarts/github/overview                         
   ...
 ```
 

diff --git a/docs/command-line-interface/topaz-cli/versioning.mdx b/docs/command-line-interface/topaz-cli/versioning.mdx
@@ -16,13 +16,30 @@ The Topaz CLI provides four commands to manage the version of the `topazd` conta
 To specify the container name and version that `topaz install` pulls, use the following command-line options:
 
 ```shell
-      --container-name="topaz"        container name
-      --container-version="latest"    container version
+      --container-registry="ghcr.io/aserto-dev"    container registry (host[:port]/repo) ($CONTAINER_REGISTRY)
+      --container-image="topaz"                    container image name ($CONTAINER_IMAGE)
+      --container-tag="latest"                     container tag ($CONTAINER_TAG)
+      --container-platform="linux/arm64"           container platform ($CONTAINER_PLATFORM)
 ```
 
+Note: the default values displayed in the help message, are automaticly adopted to the platform of the host machine.
+
+For example the container platform value
+
+| Host OS      | Host Process | Container Platform | 
+| ----------- | ------------- | ------------------ |
+| Linux       | Intel/AMD x64 | linux/amd64        |
+| Linux       | arm64         | linux/arm64        |
+| Mac         | Intel x64     | linux/amd64        |
+| Mac         | Apple silicon | linux/arm64        |
+| Windows     | Intel/AMD x64 | linux/amd64        | 
+| Windows     | arm64         | not supported      |
+
+Note: currently there exists no support for running Topaz/Topazd on Windows running on arm64 processors.
+
 ## Update
 
-`topaz update` updates the Topazd container to the latest version.
+`topaz update` updates the Topazd container to the latest version, unless the `--container-tag` command line argument or `$CONTAINER_TAG` environment variable specifies a different version.
 
 ## Uninstall
 
@@ -37,7 +54,6 @@ To specify the container name and version that `topaz install` pulls, use the fo
 Example:
 
 ```shell
-topaz version --container
-topaz 0.30.28 g314bbcd darwin-arm64 [2024-01-15T21:21:08Z]
-topazd 0.30.28
+topaz 0.31.0 g9e4ac65 darwin-arm64 [2024-02-23T19:50:14Z]
+topazd 0.31.0
 ```