Skip to content

Commit

Permalink
Merge branch 'main' into davlgd-fix-support
Browse files Browse the repository at this point in the history
  • Loading branch information
cnivolle authored Dec 2, 2024
2 parents 8a7db2d + 2809cff commit a5e5484
Show file tree
Hide file tree
Showing 38 changed files with 616 additions and 195 deletions.
18 changes: 18 additions & 0 deletions .github/external-doc-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: External doc update from PR {{ env.PR_NUMBER }}
labels: documentation
---

## External documentation update needed

Update the external documentation:

- Author: @{{ payload.sender.login }}
- PR: {{ env.PR_URL }}
- Modified files: {{ env.CHANGED_FILES }}

Make a PR on one of these repositories:

- [Astro](https://github.com/withastro/docs)


2 changes: 2 additions & 0 deletions .github/styles/Google/Acronyms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,11 @@ exceptions:
- CDN
- CSS
- CSV
- CORS
- DEBUG
- DOM
- DPI
- EOL
- FAQ
- GCC
- GDB
Expand Down
112 changes: 60 additions & 52 deletions .github/styles/config/vocabularies/Doc/accept.txt
Original file line number Diff line number Diff line change
@@ -1,65 +1,73 @@
CDNs
Cloud
Clever Cloud
add-on
callout
Hextra
shortcode
OAuth
cron
Moodle
ant
APIs
app_id
application
rclone
Laravel
monolog
syslog
proxyhugo
Filezilla
eg
Astro
Astrowind
Azimutt
Blackfire
boto
callout
CDNs
charset
checkMe
Clever Cloud
CLI
healthcheck
Cloud
cron
Cyberduck
Dockerfile
downtimes
redirections
charset
Sidekiq
eg
failover
Filestash
Filezilla
FSBucket
Gemfile
rackup
runtimes
Glassfish
Gradle
gradle
healthcheck
Heptapod
Hextra
hostname
jarName
SCMs
monorepository
monorepo
Servlet
Wildfly
Jboss
Glassfish
Payara
checkMe
Keycloak
Laravel
maven
gradle
sbt
ant
Astrowind
Matomo
Metabase
monolog
monorepo
monorepository
Moodle
nano
nmap
npm
Nuxt
Zooper
Dockerfile
failover
OAuth
Payara
Percona
Pgpool
pico
proxyhugo
psql
npm
hostname
webroot
VSCode
app_id
Heptapod
Cyberduck
Filestash
boto
Blackfire
Keycloak
FSBucket
serverless
rackup
rclone
Redict
Astro
Metabase
redirections
runtimes
sbt
scalers
SCMs
serverless
Servlet
shortcode
Sidekiq
syslog
VSCode
webroot
Wildfly
Zooper
6 changes: 5 additions & 1 deletion .github/styles/config/vocabularies/Doc/reject.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
addon
addons
addons
plug-in
plug-ins
e-mail
e-mails
65 changes: 65 additions & 0 deletions .github/workflows/external-doc-update.yml.nope
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Update external doc?

on:
pull_request_target:
types: [opened, synchronize]
branches: [ main ]

jobs:
changed_files:
runs-on: ubuntu-latest
name: Test changed-files
# Needed to post comments and create issues
permissions:
issues: write
pull-requests: write
contents: read
steps:
- uses: actions/checkout@v4
if: ${{ github.event.action == 'opened' || github.event.action == 'reopened' || github.event.action == 'synchronize' }}
with:
repository: ${{ github.event.pull_request.head.repo.full_name }}
ref: ${{ github.event.pull_request.head.ref }}
token: ${{ secrets.GITHUB_TOKEN }}
fetch-depth: 0

# Check if any external doc needs an update
- name: Get files linked to external doc
id: changed-files-specific
uses: tj-actions/changed-files@v45
with:
files: |
content/guides/astro.md

# Create issue and assign PR author
- name: Create issue
id: create-issue
if: steps.changed-files-specific.outputs.any_changed == 'true'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PR_URL: ${{ github.event.pull_request.html_url }}
PR_NUMBER: ${{ github.event.number }}
CHANGED_FILES: ${{ steps.changed-files-specific.outputs.all_changed_files }}
uses: JasonEtco/create-an-issue@v2
with:
filename: .github/external-doc-issue.yml
assignees: ${{ github.event.pull_request.user.login }}
update_existing: true
search_existing: all

# Post a single comment with auto-updating body
- name: Create or update a comment
env:
CHANGED_FILES: ${{ steps.changed-files-specific.outputs.all_changed_files }}
uses: taoliujun/action-unique-comment@v1
with:
uniqueIdentifier: ${{ github.workflow }}
body: |
You updated ${{ env.CHANGED_FILES }}. This content is also listed on external doc. Issue number ${{ steps.create-issue.outputs.number }} has been created and assigned to you 🫵👁️👄👁️

See it or modify it here:
* ${{ steps.create-issue.outputs.url }}

_This unique comment uses the very cool [taoliujun/action-unique-comment](https://github.com/marketplace/actions/unique-comment). Thank you <3_


1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.DS_Store
.idea
/public/*
/resources
.clever.json
Expand Down
8 changes: 4 additions & 4 deletions content/api/howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ The `OAuth` and doubles quotes around values are mandatory.

You need to create an OAuth consumer token in the Clever Cloud console.

A link **Create an oauth consumer** is available under your organization's addons list.
A link **Create an oauth consumer** is available under your organization's add-ons list.

All created consumers will appear below that link, like your applications and addons.
All created consumers will appear below that link, like your applications and add-ons.

These consumers allow you to register an application. By creating a consumer, users will be able to grant (or decline) privileges for your application.

Expand Down Expand Up @@ -90,7 +90,7 @@ All the API endpoints are referenced in a swagger documentation. **The base URL

{{< card link="/api/v2" title="Base v2 Endpoints" subtitle="Our base API endpoints with users, organisations, applications, add-ons, etc." icon="endpoints" >}}
{{< card link="/api/v4" title="New v4 Endpoints" subtitle="More recent API endpoints with billing, deployments, load balancers, logs, etc." icon="new" >}}

{{< /cards >}}

## WebSocket API requests
Expand Down Expand Up @@ -130,5 +130,5 @@ allows you to receive real-time logs of an application via WebSocket.
[This endpoint](https://www.clever-cloud.com/doc/api/#!/events/events_event-socket_get)
allows you to receive a stream of events emitted on your account.

Events like git push, add or remove an application / addon, deployments success / failed
Events like git push, add or remove an application / add-on, deployments success / failed
are available.
22 changes: 22 additions & 0 deletions content/changelog/2024-11-26-keycloak-26.0.06.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: "Keycloak 26.0.6 is available (security update)"
date: 2024-11-26
tags:
- addons
- keycloak
authors:
- name: Sébastien Allemand
link: https://github.com/allemas
image: https://github.com/allemas.png?size=40
- name: David Legrand
link: https://github.com/davlgd
image: https://github.com/davlgd.png?size=40
description: Thanks to Clever Cloud, it's easy to upgrade
excludeSearch: true
---

The release `26.0.6` of Keycloak is available on Clever Cloud. [It fixes](https://github.com/keycloak/keycloak/releases/26.0.6) some bugs, but also security issues: [CVE-2024-10451](https://nvd.nist.gov/vuln/detail/CVE-2024-10451), [CVE-2024-10270](https://nvd.nist.gov/vuln/detail/CVE-2024-10270), [CVE-2024-10492](https://nvd.nist.gov/vuln/detail/CVE-2024-10492), [CVE-2024-9666](https://nvd.nist.gov/vuln/detail/CVE-2024-9666) and [CVE-2024-10039](https://nvd.nist.gov/vuln/detail/CVE-2024-10039).

To update, just set `CC_KEYCLOAK_VERSION` of the add-on's Java application to `26.0.6` and rebuild it.

- [Learn more about Keycloak on Clever Cloud](/doc/addons/keycloak/)
29 changes: 29 additions & 0 deletions content/changelog/2024-11-27-clever-tools-3.10.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: 'Clever Tools 3.10 is available'
date: 2024-11-27
tags:
- clever-tools
- cli
authors:
- name: David Legrand
link: https://github.com/davlgd
image: https://github.com/davlgd.png?size=40
- name: Hubert Sablonnière
link: https://github.com/hsablonniere
image: https://github.com/hsablonniere.png?size=40
description: Some tiny changes, before the huge ones
excludeSearch: true
---

[Clever Tools 3.10](https://github.com/CleverCloud/clever-tools/releases/tag/3.10.0) is available. It includes some bug fixes on the `domain` command and supports [plugins activation](/changelog/2024-11-27-elastic-plugins-support/) for Elasticsearch add-ons at creation (supported plugins list [is here](/doc/addons/elastic/#plugins)). For example:

```bash
clever addon create es-addon --option plugins=analysis-icu,mapper-murmur3
```

To upgrade Clever Tools, [use your favorite package manager](https://github.com/CleverCloud/clever-tools/blob/master/docs/setup-systems.md#how-to-install-clever-tools). For example with `npm`:

```
npm update -g clever-tools
clever version
```
20 changes: 20 additions & 0 deletions content/changelog/2024-11-27-elastic-plugins-support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: "Elasticsearch: plugins activation support"
date: 2024-11-22
tags:
- addons
- elastic
authors:
- name: Aurélien Hebert
link: https://github.com/aurrelhebert
image: https://github.com/aurrelhebert.png?size=40
- name: David Legrand
link: https://github.com/davlgd
image: https://github.com/davlgd.png?size=40
description: More flexibility for Elasticsearch add-ons
excludeSearch: true
---

When you create an Elasticsearch add-on, you can now activate plugins through [API](/api) or the `--option` flag of [Clever Tools](https://github.com/CleverCloud/clever-tools/blob/master/docs/addons-backups.md#create--rename--delete). You must pass the option as a comma-separated list: `plugins=plugin1,plugin2`.

- Learn more about [Elasticsearch plugins support on Clever Cloud](/doc/addons/elastic/#plugins)
29 changes: 29 additions & 0 deletions content/changelog/2024-11-28-kv-explorer-available.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "Clever Cloud KV Explorer is available for Materia KV and Redis® add-ons"
date: 2024-11-28
tags:
- addons
- kv
authors:
- name: Pierre De Soyres
link: https://github.com/pdesoyres-cc
image: https://github.com/pdesoyres-cc.png?size=40
- name: David Legrand
link: https://github.com/davlgd
image: https://github.com/davlgd.png?size=40
description: Lot of changes, just an environment variable to update
excludeSearch: true
---

Since we've launched [Materia KV](https://www.clever-cloud.com/materia/materia-kv/), our serverless key-value database compatible with third-party protocols such as Redis® (and soon DynamoDB or GraphQL), customers were asking about a way to explore data directly from the Clever Cloud Console. This summer, we started to work on such a project, to provide a pleasant and easy-to-use interface, not only for Materia KV, but for any key-value add-on. After some months of internal alpha testing, it's available in Beta for all our Materia KV and Redis® add-ons.

To use it, just open the `KV Explorer` tab of any compatible add-on, it's part of the Clever Cloud experience. This first public iteration supports hash, list, set and string data types, only strings for Materia KV add-ons as other types are yet to come.

![landscape](/images/doc/kv-explorer.webp "The KV Explorer tool in the Console")

You can filter keys by type, with a filter (`*value_to_search*` for example), value text fields are multi-lines, and you can copy/paste values directly from the interface. As usual, we've worked on keyboard shortcuts and accessibility. At the bottom, the KV Explorer Terminal allows you to type any command you want as you would do in a CLI client. It works the same, you type a command, press Enter, and you get the result (yes, also when you type `FLUSHDB` or `FLUSHALL`, so be careful).

Of course, we'll continue to improve this tool, over the coming months, thanks to your feedback and suggestions. So feel free to share them and ask your questions in our [GitHub Community](https://github.com/CleverCloud/Community/discussions/categories/kv-explorer).

- [Learn more about Materia KV](/doc/addons/materia-kv/)
- [Learn more about Redis® on Clever Cloud](/doc/addons/redis/)
2 changes: 1 addition & 1 deletion content/changelog/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Additions and changes to the Clever Cloud platform.

Additions and changes to the Clever Cloud platform.

{{< hextra/hero-badge link="index.xml" style="margin:10px 0 0 0">}}
{{< hextra/hero-badge link="/changelog/index.xml" style="margin:10px 0 0 0">}}
Feed
{{< icon name="rss" attributes="height=14" >}}
{{< /hextra/hero-badge >}}
2 changes: 1 addition & 1 deletion content/doc/CLI/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ comments: false
Manage your applications from your terminal.
{{< /hextra/hero-subtitle >}}

In addition to the Clever Cloud console, you can manage your addons and applications from the command line with Clever Tools.
In addition to the Clever Cloud console, you can manage your add-ons and applications from the command line with Clever Tools.

{{< cards >}}
{{< card link="../cli/getting_started" title="Install" icon="arrow-down-tray" >}}
Expand Down
2 changes: 1 addition & 1 deletion content/doc/account/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ As of now, you can choose between 3 formats: *raw*, *slack* and *flowdock*. The
corresponding services: [Slack](https://slack.com) and [Flowdock](https://www.flowdock.com).

You can also choose which events you want and restrict notifications to a list
of applications and addons.
of applications and add-ons.

### Example: Slack deployment results Webhook

Expand Down
Loading

0 comments on commit a5e5484

Please sign in to comment.