Skip to content

Commit

Permalink
Merge branch 'main' of ssh://github.com/otterize/docs into evya/cli_o…
Browse files Browse the repository at this point in the history 
…utput_change
  • Loading branch information
@evyatarmeged
evyatarmeged committed May 24, 2023
2 parents a402f0a + da7f599 commit 9d091e9
Show file tree
Hide file tree
Showing 10 changed files with 98 additions and 60 deletions.
3 changes: 2 additions & 1 deletion docs/_common/cluster-setup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ If you don't have the Minikube CLI, first [install it](https://minikube.sigs.k8s
Then start your Minikube cluster with Calico, in order to enforce network policies.

```bash
minikube start --network-plugin=cni --cni=calico
minikube start --cpus=4 --memory 8192 --disk-size 32g --cni=calico
```
The increased CPU, memory and disk resource allocations are required to be able to deploy the ecommerce app used in the visual tutorials successfully.

</TabItem>
<TabItem value="gke" label="Google GKE">
Expand Down
8 changes: 4 additions & 4 deletions docs/_common/install-otterize-cli.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ brew install otterize/otterize/otterize-cli
<TabItem value="Apple Silicon" label="Apple Silicon">

```bash
curl -LJO https://get.otterize.com/otterize-cli/v0.1.22/otterize_macOS_arm64_notarized.zip
curl -LJO https://get.otterize.com/otterize-cli/v0.1.24/otterize_macOS_arm64_notarized.zip
tar xf otterize_macOS_arm64_notarized.zip
sudo cp otterize /usr/local/bin # optionally move to PATH
```
</TabItem>
<TabItem value="Intel 64-bit" label="Intel 64-bit">

```bash
curl -LJO https://get.otterize.com/otterize-cli/v0.1.22/otterize_macOS_x86_64_notarized.zip
curl -LJO https://get.otterize.com/otterize-cli/v0.1.24/otterize_macOS_x86_64_notarized.zip
tar xf otterize_macOS_x86_64_notarized.zip
sudo cp otterize /usr/local/bin # optionally move to PATH
```
Expand All @@ -42,7 +42,7 @@ scoop install otterize-cli
<TabItem value="64-bit" label="64-bit">

```PowerShell
Invoke-WebRequest -Uri https://get.otterize.com/otterize-cli/v0.1.22/otterize_Windows_x86_64.zip -OutFile otterize_Windows_x86_64.zip
Invoke-WebRequest -Uri https://get.otterize.com/otterize-cli/v0.1.24/otterize_Windows_x86_64.zip -OutFile otterize_Windows_x86_64.zip
Expand-Archive otterize_Windows_x86_64.zip -DestinationPath .
# optionally move to PATH
```
Expand All @@ -54,7 +54,7 @@ Expand-Archive otterize_Windows_x86_64.zip -DestinationPath .
<TabItem value="64-bit" label="64-bit">

```bash
wget https://get.otterize.com/otterize-cli/v0.1.22/otterize_Linux_x86_64.tar.gz
wget https://get.otterize.com/otterize-cli/v0.1.24/otterize_Linux_x86_64.tar.gz
tar xf otterize_Linux_x86_64.tar.gz
sudo cp otterize /usr/local/bin # optionally move to PATH
```
Expand Down
14 changes: 13 additions & 1 deletion docs/otterize-oss/usage-telemetry.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Usage telemetry
---

Operators in Otterize OSS report anonymous usage information back to the Otterize team, to help the team understand how the software is used in the community and what aspects users find useful. No personal or organizational identifying information is transmitted in these metrics: they only reflect patterns of usage. You may opt out at any time through a single configuration flag.
Otterize OSS components report anonymous usage information back to the Otterize team, to help the team understand how the software is used in the community and what aspects users find useful. No personal or organizational identifying information is transmitted in these metrics: they only reflect patterns of usage. You may opt out at any time through a single configuration flag.

## What information is collected?

Expand Down Expand Up @@ -41,6 +41,18 @@ The information reported by Otterize OSS is defined in the [GraphQL schema of th
| `ISTIO_POLICIES_DELETED` | How many Istio authorization policies were deleted by the intents operator. |
| `STARTED` | The operator was started. |

### CLI Commands

For the CLI, the reported events correspond simply to the commands invoked.

Most CLI commands are of the form `otterize <noun> <verb>` where the `<noun>` is the type of object (e.g. `intents`, `clusters`) and the `<verb>` is the operation being performed. Otterize OSS telemetry for CLI commands only reports what `<noun>` and `<verb>` were used, never what specific identifier was used in the command, nor what was the response. For example, `otterize clusters get <cluster-id>` would report that `clusters` and `get` were used, without reporting `<cluster-id>` nor the response about that cluster. In some cases, modifiers are also reported, to clarify which specific action was taken.

| Field | Meaning |
|:----------------------------------|:-----------------------------------------------------------------------------------------------------|
| `<noun>` | The type of object on which the operation (`<verb>`) is being performed. |
| `<verb>` | The operation performed on `<noun>`. |
| `MODIFIERS` | If applicable, a list of modifiers to clarify the specific operation. For example, `otterize env update add-labels` would report `add-labels` as the modifier. |

## Configuring whether to report usage information

To configure whether to report usage information to the Otterize team, use the `telemetry` flag in the installation/configuration of Otterize OSS. By default, telemetry is enabled.
Expand Down
2 changes: 1 addition & 1 deletion docs/quick-visual-tutorials/visual-ibac-network-policies.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ Otterize automatically generated network policies according to your declared int

To list all generated network policies run:
```bash
get netpol -n otterize-ecom-demo
kubectl get netpol -n otterize-ecom-demo
```

Let's inspect one of these network policies with:
Expand Down
53 changes: 34 additions & 19 deletions docs/reference/cli/README.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,33 +17,48 @@ The following are the commands offered by the Otterize CLI.

## Command structure

Most CLI commands are of the form `otterize OBJECT ACTION`. Because there are multiple objects
which each have multiple operations, this order makes the auto-completion and documentation built into the CLI
easy to access on the fly.
Most CLI commands are of the form `otterize NOUN VERB` where the `NOUN` is the type of object (e.g. `intents`, `clusters`) and the `VERB` is the operation being performed.
Putting the `NOUN` first makes the auto-completion and documentation built into the CLI easier to consume: you first choose the type of object you are interested in,
then the built-in auto-completion or documentation shows you the options on that type of object.

- `otterize -h` or `otterize --help` offers help on the various objects
- `otterize OBJECT -h` or `otterize OBJECT --help` offers help on the specified object
- `otterize OBJECT OPERATION -h` or `otterize OBJECT OPERATION --help` offers help on the specified operation
- `otterize -h` or `otterize --help` lists the various object types.
- `otterize NOUN -h` or `otterize NOUN --help` offers help on the specified object type.
- `otterize NOUN VERB -h` or `otterize NOUN VERB --help` offers help on the specified operation.

`otterize completion` offers instruction for generating command completions in various shells.


## Usage Telemetry

The CLI reports anonymous usage information back to the Otterize team, to help the team understand how the software is used in the community and what aspects users find useful. No personal or organizational identifying information is transmitted in these metrics: they only reflect patterns of usage. You may opt out at any time through a single configuration flag.

To **disable** sending usage information:
- Using a flag: `--telemetry-enabled=false`.
- Via an environment variable: `OTTERIZE_TELEMETRY_ENABLED=false`.

If the `telemetry` flag is omitted or set to `true`, telemetry will be enabled: usage information will be reported.

For more information see the [Usage telemetry Documentation](https://docs.otterize.com/otterize-oss/usage-telemetry)


## Global options

The following options apply to all CLI commands.

| Name | Default | Description |
|-------------------|--------------------------------|----------------------------------------------------------------------|
| `-h` or `--help` | | Get help on any command. |
| `--api-address` | `https://app.otterize.com/api` | The URL for the Otterize API endpoint. |
| `--client-id` | | Set the client id, for use in authenticating API calls. |
| `--client-secret` | | Set the client secret, for use in authenticating API calls. |
| `--config` | `~/.otterize/config` | Use the given path for the Otterize CLI config file. |
| `--debug` | | Show debug logs. |
| `--interactive` | true | Ask for missing flags interactively. |
| `--org-id` | | Use the given organization id when calling the Otterize API. |
| `--format` | text | Output the results of the command as text (`text`) or JSON (`json`). |
| `-q` or `--quiet` | | Suppress printing the results of the command. |
| `--token` | | The token to use in authenticating API calls. |
| Name | Default | Description |
|-----------------------|--------------------------------|----------------------------------------------------------------------------|
| `-h` or `--help` | | Get help on any command. |
| `--api-address` | `https://app.otterize.com/api` | The URL for the Otterize API endpoint. |
| `--client-id` | | Set the client id, for use in authenticating API calls. |
| `--client-secret` | | Set the client secret, for use in authenticating API calls. |
| `--config` | `~/.otterize/config` | Use the given path for the Otterize CLI config file. |
| `--debug` | | Show debug logs. |
| `--interactive` | true | Ask for missing flags interactively. |
| `--org-id` | | Use the given organization id when calling the Otterize API. |
| `--format` | text | Output the results of the command as text (`text`) or JSON (`json`). |
| `-q` or `--quiet` | | Suppress printing the results of the command. |
| `--token` | | The token to use in authenticating API calls. |
| `--telemetry-enabled` | true | Whether to enable sending of anonymous usage telemetry to Otterize or not. |

## Network mapper

Expand Down
16 changes: 9 additions & 7 deletions docs/reference/configuration/credentials-operator/helm-chart.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,15 @@ If you would like to deploy it on its own, add the Otterize Helm chart repositor
| `operator.pullPolicy` | Operator pull policy. | `(none)` |

## Cloud parameters
| Key | Description | Default |
|-------------------------------------------------|-------------------------------------------------|----------|
| `global.otterizeCloud.useCloudToGenerateTLSCredentials` | Use Otterize Cloud for certificate management instead of SPIRE | `false` |
| `global.otterizeCloud.credentials.clientId` | Client ID for connecting to Otterize Cloud. | `(none)` |
| `global.otterizeCloud.credentials.clientSecret` | Client secret for connecting to Otterize Cloud. | `(none)` |
| `global.otterizeCloud.apiAddress` | Overrides Otterize Cloud default API address. | `(none)` |
| `global.otterizeCloud.apiExtraCAPEMSecret` | The name of a secret containing a single `CA.pem` file for an extra root CA used to connect to Otterize Cloud. The secret should be placed in the same namespace as the Otterize deployment. | `(none)` |
| Key | Description | Default |
|------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
| `global.otterizeCloud.useCloudToGenerateTLSCredentials` | Use Otterize Cloud for certificate management instead of SPIRE | `false` |
| `global.otterizeCloud.credentials.clientId` | Client ID for connecting to Otterize Cloud. | `(none)` |
| `global.otterizeCloud.credentials.clientSecret` | Client secret for connecting to Otterize Cloud. | `(none)` |
| `global.otterizeCloud.credentials.secretKeyRef.secretName` | If specified, the name of a pre-created Kubernetes Secret to be used instead of creating a secret with the value of clientSecret. | `(none)` |
| `global.otterizeCloud.credentials.secretKeyRef.secretKey` | If specified, the key for the clientSecret in a pre-created Kubernetes Secret to be used instead of creating a secret with the value of clientSecret. | `(none)` |
| `global.otterizeCloud.apiAddress` | Overrides Otterize Cloud default API address. | `(none)` |
| `global.otterizeCloud.apiExtraCAPEMSecret` | The name of a secret containing a single `CA.pem` file for an extra root CA used to connect to Otterize Cloud. The secret should be placed in the same namespace as the Otterize deployment. | `(none)` |

## Common parameters
| Key | Description | Default |
Expand Down
14 changes: 8 additions & 6 deletions docs/reference/configuration/intents-operator/helm-chart.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,14 @@ If you would like to deploy it on its own, add the Otterize Helm chart repositor
| `watcher.resources` | Watcher Resources. | |

## Cloud parameters
| Key | Description | Default |
|:------------------------------------------------|:------------------------------------------------|:---------|
| `global.otterizeCloud.credentials.clientId` | Client ID for connecting to Otterize Cloud. | `(none)` |
| `global.otterizeCloud.credentials.clientSecret` | Client secret for connecting to Otterize Cloud. | `(none)` |
| `global.otterizeCloud.apiAddress` | Overrides Otterize Cloud default API address. | `(none)` |
| `global.otterizeCloud.apiExtraCAPEMSecret` | The name of a secret containing a single `CA.pem` file for an extra root CA used to connect to Otterize Cloud. The secret should be placed in the same namespace as the Otterize deployment. | `(none)` |
| Key | Description | Default |
|:-----------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------|
| `global.otterizeCloud.credentials.clientId` | Client ID for connecting to Otterize Cloud. | `(none)` |
| `global.otterizeCloud.credentials.clientSecret` | Client secret for connecting to Otterize Cloud. | `(none)` |
| `global.otterizeCloud.credentials.secretKeyRef.secretName` | If specified, the name of a pre-created Kubernetes Secret to be used instead of creating a secret with the value of clientSecret. | `(none)` |
| `global.otterizeCloud.credentials.secretKeyRef.secretKey` | If specified, the key for the clientSecret in a pre-created Kubernetes Secret to be used instead of creating a secret with the value of clientSecret. | `(none)` |
| `global.otterizeCloud.apiAddress` | Overrides Otterize Cloud default API address. | `(none)` |
| `global.otterizeCloud.apiExtraCAPEMSecret` | The name of a secret containing a single `CA.pem` file for an extra root CA used to connect to Otterize Cloud. The secret should be placed in the same namespace as the Otterize deployment. | `(none)` |

## Common parameters
| Key | Description | Default |
Expand Down

0 comments on commit 9d091e9

Please sign in to comment.