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

Adds scripts and charts updates that enable MAS deployments #722

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
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
5 changes: 5 additions & 0 deletions .changeset/green-maps-draw.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@nordeck/matrix-meetings-bot': minor
---

Updates Helm chart example and adds scripts to deploy with MAS
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
#/bin/sh
set -x;

while [ $(curl -k -sw '%{http_code}' "$HOMESERVER" -o /dev/null) -ne 302 ]; do
sleep 1;
done

# Get Static Client Access Token
ACCESS_TOKEN=$(curl -k -s \
-u "$MAS_CLIENT_ID:$MAS_CLIENT_SECRET" \
-d "grant_type=client_credentials&scope=urn:mas:admin" \
$MAS_URL/oauth2/token | grep -o '"access_token":"[^"]*"' | sed 's/"access_token":"\([^"]*\)"/\1/')

echo "Bot User:\t$USERTOCREATE"

# Create User
USER_ID=$(curl -X POST -k -s \
-d "{\"username\": \"$USERTOCREATE\"}" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
$MAS_URL/api/admin/v1/users | grep -o '"id":"[^"]*"' | sed 's/"id":"\([^"]*\)"/\1/')

if [ -n "$USER_ID" ] && [ "$USER_ID" != "null" ]; then
echo "Bot User ID:\t$USER_ID"
else
echo "Error or user $USERTOCREATE already exists."
return 1
fi

export USER_ID

# Set Password
SET_PASSWORD_RESPONSE=$(curl -X POST -k -s \
-d "{\"password\": \"$BOT_PASSWORD\", \"skip_password_check\": true}" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
$MAS_URL/api/admin/v1/users/$USER_ID/set-password)

if [ -z "$SET_PASSWORD_RESPONSE" ]; then
echo "Set-Password:\tsuccess"
else
echo "Set-Password:\t$SET_PASSWORD_RESPONSE"
fi
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
#/bin/sh

# Get Static Client Access Token
ACCESS_TOKEN=$(curl -k -s \
-u "$MAS_CLIENT_ID:$MAS_CLIENT_SECRET" \
-d "grant_type=client_credentials&scope=urn:mas:admin urn:mas:graphql:*" \
$MAS_URL/oauth2/token | grep -o '"access_token":"[^"]*"' | sed 's/"access_token":"\([^"]*\)"/\1/')

# Get Persistent Token
TOKEN_RESPONSE=$(curl -X POST -k -s \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-d "{ \
\"query\": \"mutation CreateSession(\$userId: String!, \$scope: String!) { createOauth2Session(input: {userId: \$userId, permanent: true, scope: \$scope}) { accessToken refreshToken } }\", \
\"variables\": { \
\"userId\": \"user:$USER_ID\", \
\"scope\": \"urn:matrix:org.matrix.msc2967.client:api:*\" \
} \
}" \
$MAS_URL/graphql)

PERSISTENT_TOKEN=$(echo "$TOKEN_RESPONSE" | grep -o '"accessToken":"[^"]*"' | sed 's/"accessToken":"\([^"]*\)"/\1/')

if [ -n "$PERSISTENT_TOKEN" ] && [ "$PERSISTENT_TOKEN" != "null" ]; then
echo "Persistent Token: $PERSISTENT_TOKEN"
else
echo "Unable to get a Persistent Token for $USERTOCREATE."
exit 1
fi

# Add it to the env file so it can be used by the bot
echo "ACCESS_TOKEN=$PERSISTENT_TOKEN" > /work-dir/.env
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

USER=$(psql -X -A -w -t -c "select user_id from ratelimit_override where user_id='@$USERTOCREATE:$SERVER'")
if [ "$USER" = 400 ]; then
echo "Limit is already set"
echo "Limit is already set"
exit 0
else
psql -X -A -w -t -c "insert into ratelimit_override values ('@$USERTOCREATE:$SERVER', 0, 0)"
psql -X -A -w -t -c "insert into ratelimit_override values ('@$USERTOCREATE:$SERVER', 0, 0)"
fi
exit 0

10 changes: 7 additions & 3 deletions charts/matrix-meetings-bot/templates/configmap.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,15 @@ kind: ConfigMap
apiVersion: v1
metadata:
name: {{ include "matrix-meetings-bot.fullname" . }}-sh-tools
data:
data:
{{- if .Values.init.masAuth.enabled }}
{{ tpl (.Files.Glob "files/shell-tools/create_bot_account_mas.sh").AsConfig . | indent 2 }}
{{ tpl (.Files.Glob "files/shell-tools/get_meetings_bot_token_mas.sh").AsConfig . | indent 2 }}
{{- else }}
{{ tpl (.Files.Glob "files/shell-tools/create_bot_account.sh").AsConfig . | indent 2 }}
{{ tpl (.Files.Glob "files/shell-tools/set_ratelimit_bot_db.sh").AsConfig . | indent 2 }}
{{ tpl (.Files.Glob "files/shell-tools/get_meetings_bot_token.sh").AsConfig . | indent 2 }}
{{- end }}
{{ tpl (.Files.Glob "files/shell-tools/set_ratelimit_bot_db.sh").AsConfig . | indent 2 }}
---
apiVersion: v1
kind: ConfigMap
Expand All @@ -22,4 +27,3 @@ data:
default_widget_layouts.json: |
{{- .Values.settings.config.defaultWidgetLayoutsConfig | nindent 4 -}}
{{- end }}

37 changes: 36 additions & 1 deletion charts/matrix-meetings-bot/templates/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,17 @@ spec:
- name: createbotuser
image: {{ .Values.init.synapse.image }}
env:
{{- if .Values.init.masAuth.enabled }}
- name: MAS_URL
value: {{ .Values.init.masUrl }}
- name: MAS_CLIENT_ID
value: {{ .Values.init.masClientId }}
- name: MAS_CLIENT_SECRET
valueFrom:
secretKeyRef:
name: mas-credentials
key: client_secret
{{- end }}
- name: USERTOCREATE
value: "{{ .Values.init.username }}"
- name: HOMESERVER
Expand All @@ -42,10 +53,17 @@ spec:
secretKeyRef:
name: meetings-bot-credentials
key: password
{{- if .Values.init.masAuth.enabled }}
command:
- sh
- /scripts/create_bot_account_mas.sh
- secret
{{- else }}
command:
- sh
- /scripts/create_bot_account.sh
- secret
{{- end }}
volumeMounts:
- name: synapse-config
mountPath: /data/homeserver.yaml
Expand Down Expand Up @@ -96,17 +114,34 @@ spec:
{{- end }}
{{- if .Values.init.getFreshDeviceToken.enabled }}
- name: getbottoken
image: {{ .Values.init.postgresClient.image }}
image: {{ .Values.init.synape.image }}
{{- if .Values.init.masAuth.enabled }}
command:
- sh
- /scripts/get_meetings_bot_token_mas.sh
{{- else }}
command:
- sh
- -x
- /scripts/get_meetings_bot_token.sh
{{- end }}
volumeMounts:
- name: workdir
mountPath: "/work-dir"
- name: shell-tools
mountPath: /scripts
env:
{{- if .Values.init.masAuth.enabled }}
- name: MAS_URL
value: {{ .Values.init.masUrl }}
- name: MAS_CLIENT_ID
value: {{ .Values.init.masClientId }}
- name: MAS_CLIENT_SECRET
valueFrom:
secretKeyRef:
name: mas-credentials
key: client_secret
{{- end }}
- name: USERTOCREATE
value: "{{ .Values.init.username }}"
- name: HOMESERVER
Expand Down
13 changes: 11 additions & 2 deletions charts/matrix-meetings-bot/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,19 @@ init:
username: bot-user

synapse:
image: matrixdotorg/synapse:v1.55.2
image: matrixdotorg/synapse:v1.120.2

postgresClient:
image: docker.io/bitnami/postgresql:11.12.0-debian-10-r44
image: postgres:16

masAuth:
enabled: false

masUrl:
url: 'https://your-mas-url'

masClientId:
clientId: 'mas-client-id'

createUserAccount:
enabled: false
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ The following content is available:
- `base32_room_id50`: the base32 encoded room id with max character limit of 50 as needed for Etherpad.
- `title`: the title of the meeting (=the room name).
- `uuid`: a random UUID.
- `encodeURIComponent()`: a function to encode any value to make it URL-safe
- `encodeURIComponent()`: a function to encode any value to make it URL-safe
Usage: `{{#encodeURIComponent}}my-text{{/encodeURIComponent}}`

##### Content
Expand Down
Loading