Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Merged by Bors] - feat: Add updates for fvm #706

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions .github/workflows/update-connector-docs.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,19 @@
name: Connector docs PR

permissions:
contents: read

concurrency:
group: connector-docs-${{ github.ref }}
cancel-in-progress: true

on:
#push:
# branches:
# - staging
# - trying
#pull_request:
# branches: [master]
workflow_call:
workflow_dispatch:
schedule:
Expand All @@ -22,14 +31,14 @@ jobs:
run: |
curl -fsS https://hub.infinyon.cloud/install/install.sh | bash
echo "$HOME/.fluvio/bin" >> $GITHUB_PATH

- name: Fluvio Login
run: fluvio cloud login --email ${{ secrets.CLOUD_USER_EMAIL }} --password ${{ secrets.CLOUD_USER_PASSWORD }}

- uses: Swatinem/rust-cache@v2
# Run fluvio cms

- name: Run connector docs update
run: cargo run -- connector --prod
run: cargo run -- connector

# Create/Update PR
- name: Create Pull Request
Expand Down
37 changes: 30 additions & 7 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion bors.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
status = [
"Pass client examples", "Pass html lint"
#"Pass client examples",
"Pass html lint"
]
use_squash_merge = true
delete_merged_branches = true
Expand Down
73 changes: 30 additions & 43 deletions content/cli/advanced/cli_channels.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,20 @@ menu: Release Channels
weight: 10
---

The current version of release channels was introduced in 0.10.16 with the introduction of [`fvm`]({{<ref "/cli/utilities/fluvio-version-manager.md">}})


{{<idea>}}
This is currently in BETA

%copy first-line%
```shell
$ https://hub-dev.infinyon.cloud/install_fvm/install_fvm.sh | bash
```
{{</idea>}}



## What is this for?

Occasionally users report issues in our Discord. After a fix was found and committed, users wanted a way to verify their issue had been resolved before a release.
Expand All @@ -16,12 +30,20 @@ Inspired by [Rust's concept of channels](https://rust-lang.github.io/rustup/conc

## Installation

Release channel support is provided by the [official installer script]({{<ref "/download">}}). The installer uses the `stable` channel by default.
Release channel support is provided by `fvm`. The installer uses the `stable` channel by default.

%copy first-line%
```shell
$ https://hub-dev.infinyon.cloud/install_fvm/install_fvm.sh | bash
```


{{<caution>}}
Fluvio release channels were introduced for the CLI in `0.9.16`.
Fluvio release channels were introduced for the CLI in `0.9.16`, and the most recent implementation was introduced in `0.10.16`.
<br><br>
If you have an installation from a release earlier than `0.10.16`, you should delete `~/.fluvio` directory and re-install with the [official installer script]({{<ref "/download">}}) to install `fvm`, the Fluvio Version Manager CLI.
<br><br>
If you have an installation from a release earlier than `0.9.16`, you should re-install with the [official installer script]({{<ref "/download">}}) to install the Fluvio channel frontend.
You can also run `fvm install` to migrate your existing installation
{{</caution>}}

## Quick start: The Channels
Expand All @@ -35,7 +57,7 @@ To switch to the `stable` channel:

%copy first-line%
```shell
$ fluvio version switch stable
$ fvm switch stable
```

### Latest
Expand All @@ -45,7 +67,7 @@ To switch to the `latest` channel:

%copy first-line%
```shell
$ fluvio version switch latest
$ fvm switch latest
```

The first time you switch to this channel, the binary will be downloaded.
Expand All @@ -59,49 +81,14 @@ At this step the binary will get downloaded.

%copy first-line%
```shell
$ fluvio version create X.Y.Z
$ fvm install X.Y.Z
```

Then you can switch to the version channel

%copy first-line%
```shell
$ fluvio version switch X.Y.Z
$ fvm switch X.Y.Z
```

Where `X.Y.Z` is the version of a release you want to switch to (e.g. `0.9.18`)

## How it works?

Release channel support is set up at install time through the [installer script]({{<ref "/download">}}).

2 binaries are installed
* The Fluvio CLI
* A frontend binary to support switching channels

By default, the `stable` channel is selected.

This channel is registered in `~/.fluvio/channel` and is marked as the active channel.

Example channel config:

```toml
current_channel = "stable"
[channel.stable]
binary_location = "/home/username/.fluvio/bin/fluvio-stable"
extensions = "/home/username/.fluvio/extensions"
image_tag_strategy = "Version"

[channel.latest]
binary_location = "/home/username/.fluvio/bin/fluvio-latest"
extensions = "/home/username/.fluvio/extensions-latest"
image_tag_strategy = "VersionGit"
```

When you run `fluvio update`, the Fluvio binary of your current channel will update to the newest version of the channel.

{{<caution>}}
Only the `stable` and `latest` channels can be updated. Version channels don't support `fluvio update` because those binaries will always be pinned to its version.
<br><br>
Follow the [version channel]({{<ref "#version">}}) steps to switch to a different version.
{{</caution>}}
Where `X.Y.Z` is the version of a release you want to switch to (e.g. `0.9.18`)
94 changes: 94 additions & 0 deletions content/cli/cloud/webhook.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
---
title: Cloud Webhook
menu: Webhook
weight: 30
---

The `fluvio cloud webhook` family of commands is used to create, delete, and manage webhook urls in cloud.

%copy first-line%
```bash
$ fluvio cloud webhook -h
```

{{% inline-embed file="embeds/cli/help/fluvio-cloud-webhook.md" %}}

---

## `fluvio cloud webhook create`

This command is used to create a new webhook url that maps to the current user's topic

%copy first-line%
```bash
$ fluvio cloud webhook create -h
```

{{% inline-embed file="embeds/cli/help/fluvio-cloud-webhook-create.md" %}}

Example usage:

%copy first-line%
```bash
$ fluvio cloud webhook create my-webhook-1 --topic my-topic
```

---

## `fluvio cloud webhook delete`

This command deletes a webhook url for the current user

%copy first-line%
```bash
$ fluvio cloud webhook delete -h
```

{{% inline-embed file="embeds/cli/help/fluvio-cloud-webhook-delete.md" %}}

Example usage:

%copy first-line%
```bash
$ fluvio cloud webhook delete my-webhook-1
```

---

## `fluvio cloud webhook list`

Command to show the webhooks associated with current user.

%copy first-line%
```bash
$ fluvio cloud webhook list -h
```

{{% inline-embed file="embeds/cli/help/fluvio-cloud-webhook-list.md" %}}

Example usage:

%copy first-line%
```bash
$ fluvio cloud webhook list
```

---

## `fluvio cloud webhook update`

Command to show update mapping details of a webhook url

%copy first-line%
```bash
$ fluvio cloud webhook update -h
```

{{% inline-embed file="embeds/cli/help/fluvio-cloud-webhook-update.md" %}}

Example usage:

%copy first-line%
```bash
$ fluvio cloud webhook update --topic different-topic my-webhook
```
Loading
Loading