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

Documentation update, adding solutions of the problems to a serverless tutorial #3472

Merged

Conversation

TOsmanov
Copy link
Contributor

Related #3124

Motivation and context

This PR adds information about solve possible problems in the serverless tutorial

How has this been tested?

Checklist

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.
  • I have updated the license header for each file (see an example below)
# Copyright (C) 2021 Intel Corporation
#
# SPDX-License-Identifier: MIT

@TOsmanov TOsmanov requested a review from nmanovic as a code owner July 28, 2021 08:42

1. Install [Ubuntu 18.04 from Microsoft store][ubuntu-18-04-microsoft-store].

1. Enable integration for Ubuntu-18.04 in the settings `Docker Desktop` in the `Resourcrces` `WSL integration` tab
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Enable integration for Ubuntu-18.04 in the settings `Docker Desktop` in the `Resourcrces` `WSL integration` tab
1. Enable integration for Ubuntu-18.04 in the settings `Docker Desktop` in the `Resources` `WSL integration` tab

@@ -898,6 +898,59 @@ $ docker logs nuclio-nuclio-pth.shiyinzhang.iog

</details>

### Problem with running nuctl on Windows 10

If you encounter the problem with running `nuctl` on Windows 10, you can do the following:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably the sentence can be removed. Let's recommend one way to install on Windows 10

```
1. Installation `nuctl` on Ubuntu, using the command from [manuals on nuclio CLI][nuctl-manual]:
```sh
curl -s https://api.github.com/repos/nuclio/nuclio/releases/1.5.16 \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First of all it isn't a good idea to use curl and wget in the same command. Both commands are using for the same purpose. I will recommend to simplify it for common instructions. In general we should recommend using "linux" instructions. Better to contribute into the "linux" part to make it better.

You have to install nuctl command line tool to build and deploy serverless functions. Download version 1.5.16. It is important that the version you download matches the version in docker-compose.serverless.yml After downloading the nuclio, give it a proper permission and do a softlink

sudo chmod +x nuctl-<version>-linux-amd64
sudo ln -sf $(pwd)/nuctl-<version>-linux-amd64 /usr/local/bin/nuctl

| tr -d \" \
| wget -O nuctl -qi - && chmod +x nuctl
```
1. Installation `git` on Ubuntu:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All commands below can be found in the linux installation guide.


1. After that, run the commands from this tutorial through Ubuntu.

### Problem with the deployment of models
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add the section into troubleshooting guide. If the user sees that the port is 0, need to assign it manually.

@nmanovic
Copy link
Contributor

nmanovic commented Aug 3, 2021

@TOsmanov , general comment is the following: need to unify the tutorial with its linux version as much as possible. I see only a couple of specific steps for windows.

@nmanovic nmanovic merged commit 7887da4 into cvat-ai:develop Aug 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants