Skip to content

Commit

Permalink
doc: updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ybelMekk committed Sep 20, 2021
1 parent cdcc5a2 commit ca7c787
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ Available commands:

Aiven Kafka Debug Command to apply a `aivenApplication` and extract its credentials. `avien` command will apply
an [Protected](https://doc.nais.io/persistence/kafka/#accessing-topics-from-an-application-on-legacy-infrastructure) `aivenApplication`
in your specified namespace. This will give access to personal but time limited credential. These credentials can
be used to debug an Aiven hosted kafka topic. `aiven get` command extracts the fresh `aivenApplication` credentials and
in your specified namespace. This will give access to personal but time limited credential. These credentials can be
used to debug an Aiven hosted kafka topic. `aiven get` command extracts the fresh `aivenApplication` credentials and
puts them in `current` folder. The applied `aivenApplication` has a default `expireAt` and is set to 1 day.

To gain access be sure to update
Expand Down Expand Up @@ -200,6 +200,10 @@ For more details [aiven-kcat-help](https://help.aiven.io/en/articles/2607674-usi

## Flow

Describes the underlying flow for the various commands used.

### aiven

![nais-cli under the hood](doc/nais-cli.png)

## Local Development
Expand Down
Binary file modified doc/nais-cli.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions doc/nais-cli.puml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ aivenator -> kubernetes : Delete aivenApplication
end
end

developer -> kubernetes : kubectl apply -f path/to/topic/config
loop kafkarator until success
kubernetes -> kafkarator : Topic resource created/updated
kafkarator -> aiven : Create or update topics
Expand Down

0 comments on commit ca7c787

Please sign in to comment.