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

docs: V2 documentation #44

Merged
merged 14 commits into from
May 30, 2024
Merged
Show file tree
Hide file tree
Changes from 3 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
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 4

In **Update Source Code** section, you can update the source of the application. You can update the source of the application to deploy a new version of the application.

![Update Source Code](/assets/application-update-source.png)
![Update Source Code](/assets/1.x.x/application-update-source.png)

### How to update source of the application ?
- Change the source info of the application.
Expand Down
2 changes: 1 addition & 1 deletion docs/dashboard/application_details/danger_zone.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 9

In **Danger Zone** section, you have some options which can lead to downtime of the application. So, be careful while using these options.

![Danger Zone](/assets/application-danger-zone.png)
![Danger Zone](/assets/1.x.x/application-danger-zone.png)

### Restart Application

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 7

In **Deployment Configuration** section, you can *scale up* or *scale down* the application.

![Deployment Configuration](/assets/application-deployment-configuration.png)
![Deployment Configuration](/assets/1.x.x/application-deployment-configuration.png)

**Deployment Modes -**
- **Replicated Mode** - In this mode, you can specify the number of instances you want to run for the application.
Expand Down
6 changes: 3 additions & 3 deletions docs/dashboard/application_details/deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ sidebar_position: 1

In **Deployments** section, you can see all the deployments of the application. You can check the status of the deployment and time of deployment at a glance.

![Deployment List](/assets/deployment-list.png)
![Deployment List](/assets/1.x.x/deployment-list.png)

But, you want to see more details about the deployment, you can click on the **Deployment Card** to see more details about the deployment.

Once you click on the **Deployment Card**, you will see the **Deployment Details** page like this:

![Deployment Details](/assets/deployment-details.png)
![Deployment Details](/assets/1.x.x/deployment-details.png)

Here, you can see complete details about the deployment. You can also check deployment logs to figure out what went wrong.

> 📌 While deployment is live,
- The *Deployment Logs* will be updated in realtime.
- **Request Cancellation** button will be available to cancel the deployment, if due to any reason docker build stuck, you can cancel the deployment.
![Deployment Cancel](/assets/cancel-deployment.png)
![Deployment Cancel](/assets/1.x.x/cancel-deployment.png)
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ sidebar_position: 5

In **Environment Variables** section, you can see all the environment variables of the application. You can add new environment variables, edit existing environment variables, and also can delete environment variables.

![Environment Variables](/assets/application-environment-variables.png)
![Environment Variables](/assets/1.x.x/application-environment-variables.png)

The UI is pretty simple and self-explanatory. After you change something, click on **`Apply Changes`** button to save the changes.
22 changes: 11 additions & 11 deletions docs/dashboard/application_details/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ toc_max_heading_level: 5

In **Application Details**, you can see all the details about the application. You can check the status of the application, last time when it was updated, and the number of instances running for that application.

<img src="/assets/application-details.png" alt="SwiftWave Dashboard" width="100%"/>
<img src="/assets/1.x.x/application-details.png" alt="SwiftWave Dashboard" width="100%"/>

On the right side, you can see realtime information about the count of active instances of the application.

Expand All @@ -21,14 +21,14 @@ If you like to make your application online, you can resume the application. Thi

#### 🏄‍♂️ Let's go through each section of the **Application Details** page.

| Section | Page Link |
|---------|-----------|
| Deployments | [***Click Here***](/docs/dashboard/application_details/deployments) |
| Runtime Logs | [***Click Here***](/docs/dashboard/application_details/runtime_logs) |
| Ingress Rules | [***Click Here***](/docs/dashboard/application_details/ingress_rules) |
| Update Source Code | [***Click Here***](/docs/dashboard/application_details/update_source_code) |
| Environment Variables | [***Click Here***](/docs/dashboard/application_details/environment_variables) |
| Persistent Volumes | [***Click Here***](/docs/dashboard/application_details/persistent_volumes) |
| Section | Page Link |
| ------------------------ | -------------------------------------------------------------------------------- |
| Deployments | [***Click Here***](/docs/dashboard/application_details/deployments) |
| Runtime Logs | [***Click Here***](/docs/dashboard/application_details/runtime_logs) |
| Ingress Rules | [***Click Here***](/docs/dashboard/application_details/ingress_rules) |
| Update Source Code | [***Click Here***](/docs/dashboard/application_details/update_source_code) |
| Environment Variables | [***Click Here***](/docs/dashboard/application_details/environment_variables) |
| Persistent Volumes | [***Click Here***](/docs/dashboard/application_details/persistent_volumes) |
| Deployment Configuration | [***Click Here***](/docs/dashboard/application_details/deployment_configuration) |
| Webhook CI | [***Click Here***](/docs/dashboard/application_details/webhook_ci) |
| Danger Zone | [***Click Here***](/docs/dashboard/application_details/danger_zone) |
| Webhook CI | [***Click Here***](/docs/dashboard/application_details/webhook_ci) |
| Danger Zone | [***Click Here***](/docs/dashboard/application_details/danger_zone) |
2 changes: 1 addition & 1 deletion docs/dashboard/application_details/ingress_rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 3

In **Ingress Rules** section, you can find out all the associated ingress rules for the application.

![Ingress Rules](/assets/application-ingress-rules.png)
![Ingress Rules](/assets/1.x.x/application-ingress-rules.png)

To manage the ingress rules, click on `Manage Ingress Rules` button.

Expand Down
2 changes: 1 addition & 1 deletion docs/dashboard/application_details/persistent_volumes.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 6

In **Persistent Volumes** section, you can see all the persistent volumes of the application. You can add new persistent volumes, edit existing persistent volumes, and also can delete persistent volumes.

![Persistent Volumes](/assets/application-persistent-volume.png)
![Persistent Volumes](/assets/1.x.x/application-persistent-volume.png)

You can choose pre-registered persistent volume and provide a mount path. After you change something, click on **`Apply Changes`** button to save the changes.

Expand Down
2 changes: 1 addition & 1 deletion docs/dashboard/application_details/runtime_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ sidebar_position: 2

In **Runtime Logs** section, you can see all the logs of the application. The logs are updated in realtime, so you don't have to refresh the page to check the latest logs.

![Runtime Logs](/assets/runtime-logs.png)
![Runtime Logs](/assets/1.x.x/runtime-logs.png)
2 changes: 1 addition & 1 deletion docs/dashboard/application_details/webhook_ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You can manage the webhook CI of the application from the **Webhook CI** section

This **Webhook** can be used to trigger re-deployment of the application when the source code of the application is updated.

![Webhook CI](/assets/application-webhook-ci.png)
![Webhook CI](/assets/1.x.x/application-webhook-ci.png)

**Regenerate Webhook Token** - You can regenerate the webhook URL by tapping on **Regenerate Webhook** button. If you have exposed the webhook URL to the public by mistake, then you can regenerate the webhook URL to make the old webhook URL invalid.

Expand Down
2 changes: 1 addition & 1 deletion docs/dashboard/applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 3

In **Application List**, you can see all the applications that you have created. You can check the status of the application, last time when it was updated, and the number of instances running for that application.

<img src="/assets/application-list.png" alt="SwiftWave Dashboard" width="100%"/>
<img src="/assets/1.x.x/application-list.png" alt="SwiftWave Dashboard" width="100%"/>

You can click on **`View Details`** button to see more details about the application.

Expand Down
2 changes: 1 addition & 1 deletion docs/dashboard/change_password.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ sidebar_position: 11

To **change your password**, you can click on **Change Password** button in the sidebar. You will see a form like this:

![Change Password](/assets/change-password.png)
![Change Password](/assets/1.x.x/change-password.png)

You need to enter your current password and new password. Then, click on **Change Password** button and your password will be changed.
2 changes: 1 addition & 1 deletion docs/dashboard/domains.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 7

In **Domains** section, you can manage all the custom domains you have added to swiftwave.

![Domains List](/assets/custom-domain-list.png)
![Domains List](/assets/1.x.x/custom-domain-list.png)

### Register a new domain
You can click on `Register New` button and fill in the required details to register a new domain.
Expand Down
2 changes: 1 addition & 1 deletion docs/dashboard/git-credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 5

In **Git Credentials** section, you can check all the saved Git Credentials. You can use these credentials while deploying an application from a Git Repository.

![Git Credentials List](/assets/git-credential-list.png)
![Git Credentials List](/assets/1.x.x/git-credential-list.png)

**You can**
- **Add** a new Git Credential by clicking on `Add New` button.
Expand Down
2 changes: 1 addition & 1 deletion docs/dashboard/image-credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 6

In **Image Credentials** section, you can check all the saved Image Registry Credentials. You can use these credentials while deploying an application from a Image Repository.

![Image Credentials List](/assets/image-registry-credential-list.png)
![Image Credentials List](/assets/1.x.x/image-registry-credential-list.png)

**You can**
- **Add** a new Image Registry Credential by clicking on `Add New` button.
Expand Down
28 changes: 14 additions & 14 deletions docs/dashboard/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ sidebar_position: 5
justifyContent: 'center',
marginBottom: '2rem'
}}>
<img src="/assets/dashboard-loading.png" alt="SwiftWave Dashboard" width="70%"/>
<img src="/assets/1.x.x/dashboard-loading.png" alt="SwiftWave Dashboard" width="70%"/>
</div>


Expand All @@ -20,17 +20,17 @@ SwiftWave Dashboard is a web-based interface to manage your applications, domain


## Sections of Dashboard
| Section | Description | Link |
| --- | --- | --- |
| 🔒 Log In | Log in to SwiftWave Dashboard | [***Click Here***](/docs/dashboard/log_in) |
| 🔨 Deploy New Application | Deploy new application on your server | [***Click Here***](/docs/dashboard/deploy_new_application) |
| 📦 Applications | List of all applications deployed on your server & manage them | [***Click Here***](/docs/dashboard/applications) |
| 📦 Persistent Volumes | List of all persistent volumes created on your server & manage them | [***Click Here***](/docs/dashboard/persistent-volumes) |
| 🐙 Git Credentials | Manage git credentials for your applications | [***Click Here***](/docs/dashboard/git-credentials) |
| 🐳 Image Credentials | Manage docker image credentials for your applications | [***Click Here***](/docs/dashboard/image-credentials) |
| 🌐 Domains | Manage custom domains, SSL for your applications | [***Click Here***](/docs/dashboard/domains) |
| 🚪 Ingress Rules | Manage exposed domains and routes for your applications | [***Click Here***](/docs/dashboard/ingress-rules) |
| 🔄 Redirect Rules | Manage domain redirection and HTTPS redirection for your applications | [***Click Here***](/docs/dashboard/redirect-rules) |
| 👥 Manage Users | Manage admin users for your hosted SwiftWave instance | [***Click Here***](/docs/dashboard/manage-users) |
| 🔒 Change Password | Change password for currently logged In user | [***Click Here***](/docs/dashboard/change_password) |
| Section | Description | Link |
| ------------------------ | --------------------------------------------------------------------- | ---------------------------------------------------------- |
| 🔒 Log In | Log in to SwiftWave Dashboard | [***Click Here***](/docs/dashboard/log_in) |
| 🔨 Deploy New Application | Deploy new application on your server | [***Click Here***](/docs/dashboard/deploy_new_application) |
| 📦 Applications | List of all applications deployed on your server & manage them | [***Click Here***](/docs/dashboard/applications) |
| 📦 Persistent Volumes | List of all persistent volumes created on your server & manage them | [***Click Here***](/docs/dashboard/persistent-volumes) |
| 🐙 Git Credentials | Manage git credentials for your applications | [***Click Here***](/docs/dashboard/git-credentials) |
| 🐳 Image Credentials | Manage docker image credentials for your applications | [***Click Here***](/docs/dashboard/image-credentials) |
| 🌐 Domains | Manage custom domains, SSL for your applications | [***Click Here***](/docs/dashboard/domains) |
| 🚪 Ingress Rules | Manage exposed domains and routes for your applications | [***Click Here***](/docs/dashboard/ingress-rules) |
| 🔄 Redirect Rules | Manage domain redirection and HTTPS redirection for your applications | [***Click Here***](/docs/dashboard/redirect-rules) |
| 👥 Manage Users | Manage admin users for your hosted SwiftWave instance | [***Click Here***](/docs/dashboard/manage-users) |
| 🔒 Change Password | Change password for currently logged In user | [***Click Here***](/docs/dashboard/change_password) |
tanmoysrt marked this conversation as resolved.
Show resolved Hide resolved

4 changes: 2 additions & 2 deletions docs/dashboard/ingress-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 8

In **Ingress Rules** section you can manage your ingress rules. You can add or delete ingress rules.

![Ingress Rules](/assets/ingress-rule-list.png)
![Ingress Rules](/assets/1.x.x/ingress-rule-list.png)

### 😅 Don't know what ingress rules are ?
In layman's terms, ingress rules are the rules that will connect your domain to your application.
Expand All @@ -19,7 +19,7 @@ myapp.com [https] -> myapp:3000

### Add Ingress Rule
To add an ingress rule, click on **Add New** button. You will see a form like this:
![Add Ingress Rule](/assets/add-ingress-rule.png)
![Add Ingress Rule](/assets/1.x.x/add-ingress-rule.png)

You can choose the protocol your application required.
- **HTTP**: You can choose any port for your application. It's recommended to use port 80 for HTTP.
Expand Down
2 changes: 1 addition & 1 deletion docs/dashboard/log_in.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 1

When you will visit the dashboard for the first time, you will be asked to log in.

![Log In](/assets/log-in.png)
![Log In](/assets/1.x.x/log-in.png)

You can log in using the credentials of the user you created while installing the application.

Expand Down
4 changes: 2 additions & 2 deletions docs/dashboard/manage-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ sidebar_position: 10

In **Manage Users** section, you can manage all the users of your organization.

![Manage Users](/assets/manage-users.png)
![Manage Users](/assets/1.x.x/manage-users.png)

**You can -**
1. **Create** a new user by clicking on `Create User` button.
> ⚠️ **Note :** Currently, you can only create a user with `admin` role, so new user will have all the permissions.
> We will be adding more roles for granular permission control soon.

After clicking on `Create User` button, you will see a form like this:
![Create User](/assets/create-user.png)
![Create User](/assets/1.x.x/create-user.png)

Enter the required details and click on `Create` button. The user will be created.
2. **Delete** a user by clicking on `Delete` button.
Expand Down
10 changes: 5 additions & 5 deletions docs/dashboard/persistent-volumes.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ sidebar_position: 4

In **Persistent Volumes** section, you can see all the persistent volumes created across your cluster for your applications.

![Persistent Volume List](/assets/persistent-volumes.png)
![Persistent Volume List](/assets/1.x.x/persistent-volumes.png)

### Create a Persistent Volume
1. **Local Volume**
Local volume is a volume that is created on the local storage of the node. It is not shared across the cluster.

- Click on `Add New` button.
- ![Local Volume](/assets/create-local-volume.png)
- ![Local Volume](/assets/1.x.x/create-local-volume.png)
- Choose a unique name for the volume and can't contain spaces.
- Choose type `Local`.
- Click on `Register` button and the volume will be created.
Expand All @@ -22,7 +22,7 @@ In **Persistent Volumes** section, you can see all the persistent volumes create
You can create a NFS volume to share the volume across the cluster and also to keep your data more reliable.

- Click on `Add New` button.
- ![NFS Volume](/assets/create-nfs-volume.png)
- ![NFS Volume](/assets/1.x.x/create-nfs-volume.png)
- Choose a unique name for the volume and can't contain spaces.
- Choose type `NFS`.
- Fillup NFS server details.
Expand All @@ -48,7 +48,7 @@ You can click on `Fetch Size` button to fetch size of the persistent volume.
### Backup History
You can click on `Show Backups` button to see the backup history of the volume.

![Backup History](/assets/backup-history.png)
![Backup History](/assets/1.x.x/backup-history.png)

- You can check status of old backups.
- You can also download the backup file by clicking on `Download Backup` button.
Expand All @@ -63,6 +63,6 @@ You can click on `Show Backups` button to see the backup history of the volume.
### Restore History
You can click on `Restore History` button to see the restore history of the volume.

![Restore History](/assets/restore-history.png)
![Restore History](/assets/1.x.x/restore-history.png)

- You can check status of all restores.
4 changes: 2 additions & 2 deletions docs/dashboard/redirect-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 9

In **Redirect Rules** section you can manage your redirect rules. You can add or delete redirect rules.

![Redirect Rules](/assets/redirect-rule-list.png)
![Redirect Rules](/assets/1.x.x/redirect-rule-list.png)

### 😅 Don't know what redirect rules are ?
In layman's terms, redirect rules are the rules that will redirect your domain to another URL.
Expand All @@ -17,7 +17,7 @@ In layman's terms, redirect rules are the rules that will redirect your domain t
### Add Redirect Rule
It's very easy to add a redirect rule. Just click on **Add New** button and you will see a form like this:

![Add Redirect Rule](/assets/create-redirect-rule.png)
![Add Redirect Rule](/assets/1.x.x/create-redirect-rule.png)

1. Choose the protocol (http/https) and domain you want to redirect.
2. Choose the url where you want to redirect your domain.
Expand Down
Loading
Loading