Skip to content

Commit

Permalink
Merge branch 'main' into feat/mssql-db
Browse files Browse the repository at this point in the history
Signed-off-by: Test <[email protected]>
  • Loading branch information
talboren authored Mar 24, 2024
2 parents 23b1f42 + 19e32ac commit 585bf63
Show file tree
Hide file tree
Showing 159 changed files with 6,346 additions and 1,354 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,12 +122,19 @@ Workflow triggers can either be executed manually when an alert is activated or
<img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/prometheus-icon.png?raw=true"/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/zabbix-icon.png?raw=true"/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</p>
<p align="center">
<img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/sentry-icon.png?raw=true"/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/dynatrace-icon.png?raw=true"/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/signalfx-icon.png?raw=true"/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/azuremonitoring-icon.png?raw=true"/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/gcpmonitoring-icon.png?raw=true"/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/splunk-icon.png?raw=true"/>
</p>
<h3 align="center">Databases and data warehouses</h3>
<p align="center">
Expand Down
3 changes: 3 additions & 0 deletions docs/api-ref/mapping/create-mapping.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /mapping
---
3 changes: 3 additions & 0 deletions docs/api-ref/mapping/delete-mapping-by-id.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /mapping/{mapping_id}
---
3 changes: 3 additions & 0 deletions docs/api-ref/mapping/get-mappings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /mapping
---
56 changes: 56 additions & 0 deletions docs/cli/commands/cli-config-new.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
sidebarTitle: "keep config new"
---

Create new config.

## Usage

```
Usage: keep config new [OPTIONS]...
```

## Options
* `interactive`:
* Type: BOOL
* Default: `True`
* Usage: `--interactive`

Create config interactively.

* `url`:
* Type: STRING
* Default: `http://localhost:8080`
* Usage: `--url`

The URL of the Keep backend server.

* `api-key`:
* Type: STRING
* Default: ``
* Usage: `--api-key`

The api key for authenticating over keep.

* `help`:
* Type: BOOL
* Default: `false`
* Usage: `--help`

Show this message and exit.



## CLI Help

```
Usage: keep config new [OPTIONS]
create new config.
Options:
-u, --url TEXT The url of the keep api
-a, --api-key TEXT The api key for keep
-i, --interactive Interactive mode creating keep config (default True)
--help Show this message and exit.
```
68 changes: 0 additions & 68 deletions docs/cli/commands/cli-config-provider.mdx

This file was deleted.

32 changes: 32 additions & 0 deletions docs/cli/commands/cli-config-show.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
sidebarTitle: "keep config show"
---

Show keep configuration.

## Usage

```
Usage: keep config show [OPTIONS]...
```

## Options
* `help`:
* Type: BOOL
* Default: `false`
* Usage: `--help`

Show this message and exit.



## CLI Help

```
Usage: keep config show [OPTIONS]
show the current config.
Options:
--help Show this message and exit.
```
5 changes: 3 additions & 2 deletions docs/cli/commands/cli-config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,12 @@ Usage: keep config [OPTIONS] COMMAND [ARGS]...
```
Usage: keep config [OPTIONS] COMMAND [ARGS]...
Set keep configuration.
Manage the config.
Options:
--help Show this message and exit.
Commands:
provider Set the provider configuration.
new create new config.
show show the current config.
```
75 changes: 75 additions & 0 deletions docs/cli/commands/mappings-create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
sidebarTitle: "keep mappings create"
---

Create a mapping rule.

## Usage

```
Usage: keep mappings delete [OPTIONS]
```

## Options

* `name`
* Type: STRING
* Default: ``
* Usage: `--name <mapping-name>`

The name of the mapping.

* `description`
* Type: STRING
* Default: ``
* Usage: `--description <mapping-description>`

The description of the mapping.

* `file`
* Type: STRING
* Default: ``
* Usage: `--file <mapping-file>`

The mapping file. Must be a CSV file.

* `matchers`
* Type: STRING
* Default: ``
* Usage: `--matchers <mapping-matchers>`

The matchers of the mapping, as a comma-separated list of strings.

* `priority`
* Type: INTEGER RANGE
* Default: `0`
* Usage: `--priority <priority>`

The priority of the mapping, higher priority means this rule will execute first. [0<=x<=100].

* `help`:
* Type: BOOL
* Default: `false`
* Usage: `--help`

Show this message and exit.

## CLI Help

```
Usage: keep mappings create [OPTIONS]

Create a mapping rule.

Options:
-n, --name TEXT The name of the mapping. [required]
-d, --description TEXT The description of the mapping.
-f, --file PATH The mapping file. Must be a CSV file.
[required]
-m, --matchers TEXT The matchers of the mapping, as a comma-
separated list of strings. [required]
-p, --priority INTEGER RANGE The priority of the mapping, higher priority
means this rule will execute first.
[0<=x<=100]
--help Show this message and exit.
```
41 changes: 41 additions & 0 deletions docs/cli/commands/mappings-delete.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
sidebarTitle: "keep mappings delete"
---

Delete a mapping with a specified ID.

## Usage

```
Usage: keep mappings delete [OPTIONS]
```

## Options

* `mapping-id`
* Type: STRING
* Default: ``
* Usage: `--mapping-id <mapping-id>`

The ID of the mapping to delete.

* `help`:
* Type: BOOL
* Default: `false`
* Usage: `--help`

Show this message and exit.



## CLI Help

```
Usage: keep mappings delete [OPTIONS]
Delete a mapping with a specified ID
Options:
--mapping-id INTEGER The ID of the mapping to delete. [required]
--help Show this message and exit.
```
33 changes: 33 additions & 0 deletions docs/cli/commands/mappings-list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
sidebarTitle: "keep mappings list"
---

List mappings.

## Usage

```
Usage: keep mappings [OPTIONS]
```

List mappings.

## Options

* `help`:
* Type: BOOL
* Default: `false`
* Usage: `--help`

Show this message and exit.

## CLI Help

```
Usage: keep mappings list [OPTIONS]
List mappings.
Options:
--help Show this message and exit.
```
8 changes: 8 additions & 0 deletions docs/cli/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
title: "Installation"
---
<Info>Missing an installation? submit a <a href="https://github.com/keephq/keep/issues/new?assignees=&labels=&projects=&template=use_case.md&title=">new installation</a> request and we will add it as soon as we can.</Info>

<Info>
We recommend to install Keep CLI with Python version 3.11 for optimal compatibility and performance.
This choice ensures seamless integration with all dependencies, including pyarrow, which currently does not support Python 3.12
</Info>

<Tip>Need Keep CLI on other versions? Feel free to contact us! </Tip>

## Clone and install (Option 1)

### Install
Expand Down
Loading

0 comments on commit 585bf63

Please sign in to comment.