Skip to content

Commit 4d47087

Browse files
JamieWeider72JamieWeider72
authored
Merge branch 'master' into RUN-19295-Addition
2 parents 01e6b38 + c1862cc commit 4d47087

File tree

18 files changed

+277
-82
lines changed

18 files changed

+277
-82
lines changed

‎.github/workflows/automated-publish-docs.yaml

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
name: Automated-Publish-Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- v*.*
7+
paths-ignore:
8+
- 'github/**'
9+
10+
jobs:
11+
env:
12+
runs-on: ubuntu-latest
13+
outputs:
14+
CURRENT_BRANCH: ${{ steps.calculate-env.outputs.current_branch }}
15+
NEWEST_VERSION: ${{ steps.calculate-env.outputs.newest_version }}
16+
ALIAS: ${{ steps.calculate-env.outputs.alias }}
17+
TITLE: ${{ steps.calculate-env.outputs.title }}
18+
SLACK_CHANNEL: "docs-review"
19+
steps:
20+
- name: Checkout code
21+
uses: actions/checkout@v4
22+
23+
- name: Get all v*.* branches
24+
id: calculate-env
25+
run: |
26+
BRANCHES=$(git branch --list --all | grep -v master | grep 'origin/v*.*' | sed -n -E 's:.*/(v[0-9]+\.[0-9]+).*:\1:p' | sort -Vu)
27+
NEWEST_VERSION=$(printf '%s\n' "${BRANCHES[@]}" | sort -V | tail -n 1)
28+
CURRENT_BRANCH=${GITHUB_REF#refs/heads/}
29+
ALIAS=$CURRENT_BRANCH-alias
30+
TITLE=$(echo $CURRENT_BRANCH | cut -b 2-)
31+
echo current_branch=$CURRENT_BRANCH >> $GITHUB_OUTPUT
32+
echo newest_version=$NEWEST_VERSION >> $GITHUB_OUTPUT
33+
echo alias=$ALIAS >> $GITHUB_OUTPUT
34+
echo title=$TITLE >> $GITHUB_OUTPUT
35+
36+
if [[ "$CURRENT_BRANCH" == "$NEWEST_VERSION" ]]; then
37+
echo "Deploying $NEWEST_VERSION as latest..."
38+
else
39+
echo "Deploying $CURRENT_BRANCH which is not the latest version ( => $NEWEST_VERSION )..."
40+
fi
41+
42+
install-dependencies-and-deploy:
43+
name: Install Dependencies and Deploy
44+
needs: [env]
45+
runs-on: ubuntu-latest
46+
steps:
47+
- name: checkout latest
48+
uses: actions/checkout@v4
49+
with:
50+
ref: ${{ needs.env.outputs.CURRENT_BRANCH }}
51+
fetch-depth: 0
52+
53+
- name: setup python
54+
uses: actions/setup-python@v5
55+
with:
56+
python-version: '3.9'
57+
cache: 'pip' # caching pip dependencies
58+
59+
- name: install dependencies
60+
run: |
61+
pip3 install -r requirements.txt
62+
63+
- name: Configure Git User
64+
run: |
65+
git config user.name "circleci-runai"
66+
git config user.email "circleci-runai@run.ai"
67+
68+
- name: deploy mkdocs
69+
run: |
70+
if [[ "${{ needs.env.outputs.CURRENT_BRANCH }}" == "${{ needs.env.outputs.NEWEST_VERSION }}" ]]; then
71+
echo "Deploying ${{ needs.env.outputs.NEWEST_VERSION }} as latest..."
72+
mike list
73+
git fetch origin gh-pages --depth=1
74+
mike deploy ${{ needs.env.outputs.CURRENT_BRANCH }} ${{ needs.env.outputs.ALIAS }} latest --title=${{ needs.env.outputs.TITLE }} --push --update-aliases
75+
mike set-default latest --push
76+
mike list
77+
else
78+
echo "Deploying ${{ needs.env.outputs.CURRENT_BRANCH }} which is not the latest version ( => ${{ needs.env.outputs.NEWEST_VERSION }} )..."
79+
mike list
80+
git fetch origin gh-pages --depth=1
81+
mike deploy ${{ needs.env.outputs.CURRENT_BRANCH }} ${{ needs.env.outputs.ALIAS }} --title=${{ needs.env.outputs.TITLE }} --push
82+
mike list
83+
fi
84+
85+
slack-notification:
86+
name: Slack Notification
87+
needs: [env, install-dependencies-and-deploy]
88+
if: always()
89+
runs-on: ubuntu-latest
90+
steps:
91+
- name: Slack Notification
92+
uses: rtCamp/action-slack-notify@v2
93+
env:
94+
SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
95+
SLACK_COLOR: ${{ contains(needs.*.result, 'failure') && 'failure' || 'success' }}
96+
SLACK_TITLE: "RunAI-Docs: Version ${{ needs.env.outputs.CURRENT_BRANCH }} Deployment ${{ contains(needs.*.result, 'failure') && 'failed' || 'completed successfully' }}"
97+
SLACK_MESSAGE_ON_SUCCESS: "Docs were updated successfully for version ${{ needs.env.outputs.TITLE }}"
98+
SLACK_MESSAGE_ON_FAILURE: "Docs update FAILED for version ${{ needs.env.outputs.TITLE }}"
99+
MSG_MINIMAL: true
100+
SLACK_FOOTER: ""

‎.github/workflows/ci.yml.old

Lines changed: 0 additions & 30 deletions
This file was deleted.

‎.github/workflows/create-preview-env-on-pr.yaml

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
name: Create Preview Environment on PR
2+
3+
on:
4+
pull_request:
5+
types: [opened, reopened, synchronize, closed]
6+
branches:
7+
- master
8+
- v*.*
9+
10+
jobs:
11+
build-and-deploy:
12+
if: github.event.action != 'closed' && github.repository == 'run-ai/docs'
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Checkout code
16+
uses: actions/checkout@v4
17+
18+
- name: setup python
19+
uses: actions/setup-python@v5
20+
with:
21+
python-version: '3.9'
22+
cache: 'pip' # caching pip dependencies
23+
24+
- name: install dependencies
25+
run: |
26+
pip3 install -r requirements.txt
27+
28+
- name: mkdocs-build-action
29+
run: |
30+
mkdocs build
31+
32+
- name: Install AWS CLI
33+
run: |
34+
sudo apt-get update
35+
sudo apt-get install awscli -y
36+
37+
- name: Sync S3 bucket for preview
38+
env:
39+
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
40+
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
41+
AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION }}
42+
run: |
43+
aws s3 sync ./site/ s3://${{ secrets.AWS_S3_BUCKET_NAME }}/PR-${{ github.event.number }} --delete
44+
45+
- name: Invalidate CloudFront cache
46+
env:
47+
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
48+
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
49+
AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION }}
50+
run: |
51+
aws cloudfront create-invalidation --distribution-id ${{ secrets.AWS_CLOUDFRONT_DISTRIBUTION_ID }} --paths "/PR-${{ github.event.number }}/*"
52+
53+
- name: Comment on PR with preview URL
54+
uses: actions/github-script@v6
55+
with:
56+
script: |
57+
github.rest.issues.createComment({
58+
issue_number: context.issue.number,
59+
owner: context.repo.owner,
60+
repo: context.repo.repo,
61+
body: `Preview environment URL: https://d161wck8lc3ih2.cloudfront.net/PR-${{ github.event.number }}/`
62+
})
63+
64+
cleanup:
65+
if: github.event.action == 'closed' && github.repository == 'run-ai/docs'
66+
runs-on: ubuntu-latest
67+
steps:
68+
- name: Install AWS CLI
69+
run: |
70+
sudo apt-get update
71+
sudo apt-get install awscli -y
72+
73+
- name: Remove PR directory from S3 bucket
74+
env:
75+
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
76+
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
77+
AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION }}
78+
run: |
79+
aws s3 rm s3://${{ secrets.AWS_S3_BUCKET_NAME }}/PR-${{ github.event.number }} --recursive

‎.github/workflows/deploy-staging.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ jobs:
4141
with:
4242
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
4343
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
44-
aws-region: us-east-1
44+
aws-region: ${{ secrets.AWS_DEFAULT_REGION}}
4545

4646
- name: Sync output to S3
4747
run: |

‎docs/Researcher/cli-reference/runai-submit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ runai submit --job-name-prefix -i gcr.io/run-ai-demo/quickstart -g 1
187187
188188
#### --stdin
189189

190-
> Keep stdin open for the container(s) in the pod, even if nothing is attached.is attached.
190+
> Keep stdin open for the container(s) in the pod, even if nothing is attached.
191191
192192
#### -t | --tty
193193

‎docs/Researcher/scheduling/gpu-memory-swap.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,7 @@ If you prefer your workloads not to be swapped into CPU memory, you can specify
107107

108108
## Known Limitations
109109

110+
* A pod created before the GPU memory swap feature was eneabled in that cluster, cannot be scheduled to a swap-enabled node. A proper event is generated in case no matching node is found. Users must re-submit those pods to make them swap-enabled.
110111
* GPU memory swap cannot be enabled if fairshare time-slicing or strict time-slicing is used, GPU memory swap can only be used with the default time-slicing mechanism.
111112
* CPU RAM size cannot be decreased once GPU memory swap is enabled.
112113

‎docs/Researcher/user-interface/workspaces/create/create-ds.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,12 @@ To create a host path data source, provide:
7272
## Create a ConfigMap data source
7373

7474
* A Run:ai project scope which is assigned to that item and all its subsidiaries.
75-
75+
7676
!!! Note
7777
You can only choose a project as a scope.
7878

79+
ConfigMaps must be created on the cluster before being used within Run:ai. When created, the ConfigMap must have a label of `run.ai/resource: <resource-name>`. The resource name specified must be unique to that created resource.
80+
7981
* A data source name.
8082
* A data mount consisting of:
8183

@@ -86,7 +88,7 @@ To create a host path data source, provide:
8688

8789
* A Run:ai project scope which is assigned to that item and all its subsidiaries.
8890
* A *Credentials*. To create a new *Credentials*, see [Configuring Credentials](../../../../admin/admin-ui-setup/credentials-setup.md#configuring-credentials)
89-
91+
9092
!!! Note
9193
You can only choose a project as a scope.
9294

‎docs/admin/runai-setup/cluster-setup/cluster-install.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ On the next page:
2727
* Run the [Helm](https://helm.sh/docs/intro/install/) command provided in the wizard.
2828
* In case of a failure, see the [Installation troubleshooting guide](../../troubleshooting/troubleshooting.md#installation).
2929

30+
!!! Note
31+
A kubernetes user with `cluster-admin` role is required to ensure a successfull installation, for more information see [using RBAC Authorization](https://kubernetes.io/docs/reference/access-authn-authz/rbac/){target=_blank}.
32+
3033
## Verify your cluster's health
3134

3235
* Verify that the cluster status in the Run:ai Control Plane's [Clusters Table](#cluster-table) is `Connected`.

‎docs/admin/runai-setup/cluster-setup/cluster-prerequisites.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Following is a Kubernetes support matrix for the latest Run:ai releases:<a name=
6262
| Run:ai 2.15 | 1.25 through 1.28 | 4.11 through 4.13 |
6363
| Run:ai 2.16 | 1.26 through 1.28 | 4.11 through 4.14 |
6464
| Run:ai 2.17 | 1.27 through 1.29 | 4.12 through 4.15 |
65-
| Run:ai 2.18 | 1.28 through 1.30 | 4.12 through 4.15 |
65+
| Run:ai 2.18 | 1.28 through 1.30 | 4.12 through 4.16 |
6666

6767
For information on supported versions of managed Kubernetes, it's important to consult the release notes provided by your Kubernetes service provider. Within these notes, you can confirm the specific version of the underlying Kubernetes platform supported by the provider, ensuring compatibility with Run:ai.
6868

‎docs/admin/runai-setup/cluster-setup/cluster-upgrade.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,16 @@ and record the chart version in the form of `runai-cluster-<version-number>`
1313

1414
## Upgrade Run:ai cluster
1515

16-
17-
### Upgrade to version 2.15
18-
19-
The cluster installation has changed in version 2.15 such that no _values file_ ia needed and old customizations do not have to be copied. Hence, simply follow the instructions for [Installing Run:ai](cluster-install.md#install-runai) to install Run:ai.
20-
21-
All customizations done in `RunaiConfig` are saved during the upgrade.
22-
23-
### Upgrade from version 2.9, 2.10, 2.11 or 2.12 to version 2.13
24-
25-
16+
### Upgrade from version 2.15+
17+
* In the Run:ai interface, navigate to `Clusters`.
18+
* Select the cluster you want to upgrade.
19+
* Click on `Get Installation instructions`.
20+
* Choose the `Run:ai version` to be installed on the Cluster.
21+
* Press `Continue`.
22+
* Copy the [Helm](https://helm.sh/docs/intro/install/) command provided in the `Installation Instructions` and run it on in the cluster.
23+
* In the case of a failure, refer to the [Installation troubleshooting guide](../../troubleshooting/troubleshooting.md#installation).
24+
25+
### Upgrade from version 2.9, 2.10, 2.11 or 2.12
2626
Run:
2727

2828
```

0 commit comments

Comments
 (0)