Skip to content

Commit

Permalink
tag images to add/update alt-text
Browse files Browse the repository at this point in the history
  • Loading branch information
pavithraes committed Nov 14, 2022
1 parent 07e091f commit 2482de1
Show file tree
Hide file tree
Showing 15 changed files with 58 additions and 58 deletions.
8 changes: 4 additions & 4 deletions docs/docs/get-started/cloud-providers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import TabItem from '@theme/TabItem';
<TabItem value="gcp" label="Google GCP" default>

<div class="text--center">
<img src="/img/get-started/started-google-cloud-logo.png" width={420} />
<img src="/img/get-started/started-google-cloud-logo.png" alt="" width={420} />
</div>

[Google GCP](https://cloud.google.com/) (also known as Google Cloud Platform or GCP) is a provider of computing resources for developing, deploying, and operating computing services.
Expand All @@ -39,7 +39,7 @@ For detailed instructions on how to deploy Nebari on **GCP** visit the [How to d
<TabItem value="do" label="Digital Ocean">

<div class="text--center">
<img src="/img/get-started/started-digital-ocean-logo.png" width={420} />
<img src="/img/get-started/started-digital-ocean-logo.png" alt="" width={420} />
</div>

[DigitalOcean](https://docs.digitalocean.com/products/kubernetes/) is a cloud hosting provider that offers cloud computing services and Infrastructure as a Service (IaaS) known for its pricing and scalability.
Expand All @@ -50,7 +50,7 @@ For detailed instructions on how to deploy Nebari on **Digital Ocean** visit the
<TabItem value="aws" label="Amazon AWS">

<div class="text--center">
<img src="/img/get-started/started-amazon-web-services-logo.png" width={420} />
<img src="/img/get-started/started-amazon-web-services-logo.png" alt="" width={420} />
</div>

[Amazon Web Services (AWS)](https://aws.amazon.com/eks/) is a comprehensive, evolving cloud computing platform provided by Amazon that includes a mixture of infrastructure as a service (IaaS), platform as a service (PaaS) and packaged software as a service (SaaS) offerings.
Expand All @@ -61,7 +61,7 @@ For detailed instructions on how to deploy Nebari on **AWS** visit the [How to d
<TabItem value="azure" label="Azure">

<div class="text--center">
<img src="/img/get-started/started-azure-logo.png" width={420}/>
<img src="/img/get-started/started-azure-logo.png" alt="" width={420}/>
</div>

[Microsoft Azure](https://azure.microsoft.com/en-us/services/kubernetes-service/) is Microsoft's public cloud computing platform. It provides a range of cloud services, including compute, analytics, storage and networking.
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/get-started/installing-nebari.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ You can verify that Nebari is properly installed, and you are able to execute th
nebari --help
```

![A representation of the output generated when Nebari help command argument is executed, the output contains a list of the available commands and their use.](/img/get-started/nebari-help.png "Nebari's help command line output")
![A representation of the output generated when Nebari help command argument is executed, the output contains a list of the available commands and their use. ](/img/get-started/nebari-help.png "Nebari's help command line output")

:::note Troubleshooting
If you are unable to successfully validate the Nebari installation above, you may want to check out our [troubleshooting guide][nebari-troubleshooting].
Expand All @@ -75,7 +75,7 @@ You can pass the `--help` flag to the `init` command to check all the arguments
nebari init --help
```

![A representation of the output generated when Nebari init help command is executed, the output contains a list of the available options and arguments and their use.](/img/get-started/nebari-init-help-2.png "Nebari's init help command line output")
![A representation of the output generated when Nebari init help command is executed, the output contains a list of the available options and arguments and their use. ](/img/get-started/nebari-init-help-2.png "Nebari's init help command line output")

:::tip
You can pass the `--guided-init` flag to the `init` command to interact with Guided Init Wizard.
Expand Down
20 changes: 10 additions & 10 deletions docs/docs/how-tos/configure-keycloak-howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,20 +40,20 @@ After the initial deployment, it is **highly** recommended that you change the K
1. To change the `root` user password, go to your Nebari instance's admin dashboard - e.g., something like `https://{your-nebari-domain}/auth/admin/` and log in with the root password provided.

<p align="center">
<img src="/img/how-tos/keycloak_master_login.png" alt="Nebari admin view - Root Login to Keycloak form" width="400"/>
<img src="/img/how-tos/keycloak_master_login.png" alt="Nebari admin view - Root Login to Keycloak form " width="400"/>
</p>

2. From there, click on the **Root** dropdown in the top right of the screen, and select **Manage account**.

![Keycloak root user page - manage account tab selected](/img/how-tos/keycloak_root_user_manage_account.png)
![Keycloak root user page - manage account tab selected ](/img/how-tos/keycloak_root_user_manage_account.png)

3. Under **Account Security** click **Signing In**.

![Keycloak root user page - account security](/img/how-tos/keycloak_root_user_account_security.png)
![Keycloak root user page - account security ](/img/how-tos/keycloak_root_user_account_security.png)

4. In the Password section, click the **Update** button. This will guide you through entering your existing root password, and then creating a new password.

![Keycloak root user page - account security, update password](/img/how-tos/keycloak_root_user_update_password.png)
![Keycloak root user page - account security, update password ](/img/how-tos/keycloak_root_user_update_password.png)

:::warning
The `security.keycloak.initial_root_password` field in `nebari-config.yaml` has no effect after changing the `root` password. If you redeploy Nebari it **will not reset** the password back to the old one (or anything else that might be in the field in your YAML file). We strongly recommend you delete this field to prevent later confusion.
Expand Down Expand Up @@ -83,7 +83,7 @@ Steps to create a new user:

2. Click the **Add user** button, and you will see the new user form:

![Keycloak add user tab screenshot - new user form](/img/how-tos/keycloak_add_users.png)
![Keycloak add user tab screenshot - new user form ](/img/how-tos/keycloak_add_users.png)

3. Fill out the three fields outlined above. These are **Username**, **Email**, and **Groups**. (See explanation below). Then click **save**.

Expand All @@ -110,7 +110,7 @@ If you are using the password authentication provider, you will also need to def
If using Auth0, GitHub or any other identity provider, the password field is not required.
:::

![Keycloak add user > credentials tab screenshot - set password](/img/how-tos/keycloak_user_password.png)
![Keycloak add user > credentials tab screenshot - set password ](/img/how-tos/keycloak_user_password.png)

### Add user from the command line

Expand All @@ -130,7 +130,7 @@ This will create a new user `<username>` under the `analyst` group, with the ini

Your new user can now log in to Nebari, visit your provided Nebari domain URI which will take you to the login form page and follow the [How-to login in to Nebari and start a server][keycloak-login].

![Nebari - Log in to Keycloak page](/img/how-tos/nebari_login_screen.png)
![Nebari - Log in to Keycloak page ](/img/how-tos/nebari_login_screen.png)

## In-depth look at Roles and Groups

Expand Down Expand Up @@ -162,15 +162,15 @@ As an example, we create a new group named `conda-store-manager`. This group wil

1. Click **New** in the upper-right hand corner under **Groups**.

![Keycloak groups tab screenshot - user groups view](/img/how-tos/keycloak_groups.png)
![Keycloak groups tab screenshot - user groups view] (/img/how-tos/keycloak_groups.png)

- Then, give the new group an appropriate name.

![Keycloak add group form - name field set to conda-store-manager](/img/how-tos/keycloak_new_group1.png)
![Keycloak add group form - name field set to conda-store-manager ](/img/how-tos/keycloak_new_group1.png)

2. Under **Role Mapping**, add the appropriate **Client Roles** as needed; there should be no need to update the **Realm Roles**.

![Keycloak group conda-store-manager form - role mappings tab focused with expanded client roles dropdown](/img/how-tos/keycloak_new_group2.png)
![Keycloak group conda-store-manager form - role mappings tab focused with expanded client roles dropdown ](/img/how-tos/keycloak_new_group2.png)

In this example, the new group only has one mapped role, `conda_store_admin`; however, it's possible to attach multiple **Client Roles** to a single group.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/how-tos/debug-nebari.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ configuration in the `kubeconfig` to dial the connection with the cluster.

To view all the current processes press 0:

![Image of the k9s terminal UI](/img/how-tos/k9s_UI.png)
![Image of the k9s terminal UI ](/img/how-tos/k9s_UI.png)

Using `k9s` you can inspect any services launched by your cluster. For
example, if your cluster has problems with the network traffic tunnel
Expand Down
10 changes: 5 additions & 5 deletions docs/docs/how-tos/domain-registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,15 @@ To generate a token follow the steps below. For additional information, see the

- Under Profile, select the API Tokens menu and click on Create API Token.

- On Edit zone DNS click on Use Template.![screenshot Cloudflare edit Zone DNS](/img/how-tos/cloudflare_auth_1.png).
- On Edit zone DNS click on Use Template.![screenshot Cloudflare edit Zone DNS ](/img/how-tos/cloudflare_auth_1.png).

- Configure Permissions such as the image below:![screenshot Cloudflare Permissions edit](/img/how-tos/cloudflare_permissions_2.1.1.png)
- Configure Permissions such as the image below:![screenshot Cloudflare Permissions edit ](/img/how-tos/cloudflare_permissions_2.1.1.png)

- On Account Resources set the configuration to include your desired account.![screenshot Cloudflare account resources](/img/how-tos/cloudflare_account_resources_scr.png)
- On Account Resources set the configuration to include your desired account.![screenshot Cloudflare account resources ](/img/how-tos/cloudflare_account_resources_scr.png)

- On Zone Resources set it to Include | Specific zone and your domain name.![screenshot Cloudflare zone resources](/img/how-tos/cloudflare_zone_resources.png)
- On Zone Resources set it to Include | Specific zone and your domain name.![screenshot Cloudflare zone resources ](/img/how-tos/cloudflare_zone_resources.png)

- Click continue to summary.![screenshot Cloudflare summary](/img/how-tos/cloudflare_summary.png)
- Click continue to summary.![screenshot Cloudflare summary ](/img/how-tos/cloudflare_summary.png)

- Click on the Create Token button and set the token generated as an environment variable on your machine.

Expand Down
12 changes: 6 additions & 6 deletions docs/docs/how-tos/login-thru-keycloak-howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Navigate to the cluster homepage, for instance [`https://demo.nebari.dev`](https
Once on the site, you will be prompted to log in, similar to
the login page shown in the image below.

![Nebari login screen](/img/how-tos/nebari_login_screen.png)
![Nebari login screen ](/img/how-tos/nebari_login_screen.png)

Nebari uses [Keycloak](https://www.keycloak.org/), an open-source identity and access management tool. Keycloak is a centralized location for administrators to add new users, create user groups and update roles. For more information, see the [How to Configure Keycloak][nebari-keycloak] docs.

Expand All @@ -33,12 +33,12 @@ For more information on how to configure Keycloak, and add new users, review the
In this example, Auth0 is acting as our identity provider. To continue the login process, the user selects the `Auth0` button and logs into through Auth0.

<p align="center">
<img src="/img/how-tos/keycloak_nebari_login.png" alt="Nebari Keycloak auth screen - shows a form to provide username or password or to authenticate through Auth0" width="400"/>
<img src="/img/how-tos/keycloak_nebari_login.png" alt="Nebari Keycloak auth screen - shows a form to provide username or password or to authenticate through Auth0 " width="400"/>
</p>

Once authenticated, you will be forwarded to the main JupyterHub page. On this page, you will find links to all of Nebari's core features, and it is where you can launch your JupyterLab pod. If you are an admin, you'll also have access to the JupyterHub `Admin` management.

![Nebari dashboard main screen - displays a button "Start my server"](/img/how-tos/nebari_main_hub_page.png)
![Nebari dashboard main screen - displays a button "Start my server" ](/img/how-tos/nebari_main_hub_page.png)

## 3. Selecting a Profile

Expand All @@ -49,22 +49,22 @@ The customized profiles will give you access to fixed cloud resources. In this e
These options are configured by your administrator. A more detailed explanation of dedicated profiles can be found in the Profiles section of
the advanced configuration page.

![Nebari select profile](/img/how-tos/nebari_select_profile.png)
![Nebari select profile ](/img/how-tos/nebari_select_profile.png)

## 4. Starting your server

Once an appropriate profile has been selected, click `start`. At this point, your JupyterLab pod instance will be launched. This step may take up to several minutes due to Nebari use of autoscaling under the hood.

Ultimately this autoscaling feature helps reduce costs when the cluster is idle. A successful launch should look similar to the image below.

![Nebari start server](/img/how-tos/nebari_server_start.png)
![Nebari start server ](/img/how-tos/nebari_server_start.png)

<details>
<summary>Event Log</summary>

During this time you might see some log messages that detail the autoscaling process. To view all the logs, click the **Event Log** button. They should look similar to the following:

![Nebari event log](/img/how-tos/keycloak_start_event_logs.png)
![Nebari event log ](/img/how-tos/keycloak_start_event_logs.png)

</details>

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/how-tos/nebari-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ environment variables have been properly set. It is time to initialize and deplo
nebari init --guided-init
```

![A representation of the output generated when Nebari init guided-init command is executed.](/img/how-tos/nebari-aws.png)
![A representation of the output generated when Nebari init guided-init command is executed. ](/img/how-tos/nebari-aws.png)

:::tip
If you prefer not using the `guided-init` command then you can directly run the `init` command.
Expand Down Expand Up @@ -181,7 +181,7 @@ To see all the options available for the deploy command, run the following comma
nebari deploy --help
```
![A representation of the output generated when nebari deploy help command is executed.](/img/how-tos/nebari-deploy-help.png)
![A representation of the output generated when nebari deploy help command is executed. ](/img/how-tos/nebari-deploy-help.png)
With the `nebari-config.yaml` configuration file now created, Nebari can be deployed for the first time. Type the following command on your command line:
Expand Down Expand Up @@ -225,7 +225,7 @@ To see all the options available for the destroy command, type the following com
nebari destroy --help
```
![A representation of the output generated when nebari deploy help command is executed.](/img/how-tos/nebari-destroy-help.png)
![A representation of the output generated when nebari deploy help command is executed. ](/img/how-tos/nebari-destroy-help.png)
Nebari also has a `destroy` command that works the same way the deploy works but instead of creating the provisioned resources it destroys it.
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/how-tos/nebari-azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ environment variables have been properly set. It is time to initialize and deplo
nebari init --guided-init
```

![A representation of the output generated when Nebari init guided-init command is executed.](/img/how-tos/nebari-azure.png)
![A representation of the output generated when Nebari init guided-init command is executed. ](/img/how-tos/nebari-azure.png)

:::tip
If you prefer not using the `guided-init` command then you can directly run the `init` command.
Expand Down Expand Up @@ -163,7 +163,7 @@ To see all the options available for the deploy command, run the following comma
nebari deploy --help
```
![A representation of the output generated when nebari deploy help command is executed.](/img/how-tos/nebari-deploy-help.png)
![A representation of the output generated when nebari deploy help command is executed. ](/img/how-tos/nebari-deploy-help.png)
With the `nebari-config.yaml` configuration file now created, Nebari can be deployed for the first time. Type the following command on your command line:
Expand Down Expand Up @@ -207,7 +207,7 @@ To see all the options available for the destroy command, type the following com
nebari destroy --help
```
![A representation of the output generated when nebari deploy help command is executed.](/img/how-tos/nebari-destroy-help.png)
![A representation of the output generated when nebari deploy help command is executed. ](/img/how-tos/nebari-destroy-help.png)
Nebari also has a `destroy` command that works the same way the deploy works but instead of creating the provisioned resources it destroys it.
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/how-tos/nebari-destroy.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,11 @@ Here, we outline how to find and destroy resources from the AWS console.

1. Sign in to your AWS account and in the search bar type `Tag Editor`

<img src="/img/how-tos/aws_tag_editor_1.png" alt="Search for Tag Editor in the AWS console" width="700"/>
<img src="/img/how-tos/aws_tag_editor_1.png" alt="Search for Tag Editor in the AWS console " width="700"/>

2. From the `Resource Groups & Tag Editor` page, navigate to `Tag Editor` from the left most panel

<img src="/img/how-tos/aws_tag_editor_2.png" alt="Navigate to the Tag Editor in the AWS console" width="200"/>
<img src="/img/how-tos/aws_tag_editor_2.png" alt="Navigate to the Tag Editor in the AWS console " width="200"/>

3. Fill out the form as follows:
- `Regions` - the region you deployed your Nebari cluster (or select `all regions`)
Expand All @@ -95,7 +95,7 @@ Here, we outline how to find and destroy resources from the AWS console.
- select `Environment` for key (on the left)
- enter the namespace you chose for your Nebari cluster (on the right)

<img src="/img/how-tos/aws_tag_editor_3.png" alt="Use the Tag Editor to filter for lingering Nebari resources" width="700"/>
<img src="/img/how-tos/aws_tag_editor_3.png" alt="Use the Tag Editor to filter for lingering Nebari resources " width="700"/>

4. From here you can filter further if needed by entering the name of your Nebari cluster.

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/how-tos/nebari-do.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ environment variables have been properly set. It is time to initialize and deplo
nebari init --guided-init
```

![A representation of the output generated when Nebari init guided-init command is executed.](/img/how-tos/nebari-do.png)
![A representation of the output generated when Nebari init guided-init command is executed. ](/img/how-tos/nebari-do.png)

:::tip
If you prefer not using the `guided-init` command then you can directly run the `init` command.
Expand Down Expand Up @@ -161,7 +161,7 @@ To see all the options available for the deploy command, run the following comma
nebari deploy --help
```
![A representation of the output generated when nebari deploy help command is executed.](/img/how-tos/nebari-deploy-help.png)
![A representation of the output generated when nebari deploy help command is executed. ](/img/how-tos/nebari-deploy-help.png)
With the `nebari-config.yaml` configuration file now created, Nebari can be deployed for the first time. Type the following command on your command line:
Expand Down Expand Up @@ -203,7 +203,7 @@ To see all the options available for the destroy command, type the following com
nebari destroy --help
```
![A representation of the output generated when nebari deploy help command is executed.](/img/how-tos/nebari-destroy-help.png)
![A representation of the output generated when nebari deploy help command is executed. ](/img/how-tos/nebari-destroy-help.png)
Nebari also has a `destroy` command that works the same way the deploy works but instead of creating the provisioned resources it destroys it.
Expand Down
Loading

0 comments on commit 2482de1

Please sign in to comment.