mirror of
https://github.com/rancher-sandbox/rancher-desktop.git
synced 2021-10-13 00:04:06 +03:00
Initial documentation addition
Signed-off-by: Matt Farina <matt.farina@suse.com>
This commit is contained in:
7
docs/README.md
Normal file
7
docs/README.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Rancher Desktop Documentation
|
||||
|
||||
The documentation provides documentation to introduce you to using Rancher
|
||||
Desktop. Current documentation covers:
|
||||
|
||||
- [Installing Rancher Desktop](installing.md)
|
||||
- [Working with images](images.md)
|
||||
41
docs/images.md
Normal file
41
docs/images.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# Images
|
||||
|
||||
Rancher Desktop provides the ability to build, push, and pull images via the
|
||||
[KIM](https://github.com/rancher/kim) project.
|
||||
|
||||
Note, on Mac `kim` is put into the path. This feature is not yet working on
|
||||
Windows and you will need to either manually add the binary to your path or
|
||||
install KIM directly. Adding KIM to your path is coming soon.
|
||||
|
||||
## Using KIM
|
||||
|
||||
You can learn about all of the command options by running `kim -h`. This will
|
||||
display the help documentation.
|
||||
|
||||
KIM has a client side and server side component. The server side part is a
|
||||
container running in Kubernetes while the client side application runs on
|
||||
Mac or Windows. Images are stored in the same containerd that Kubernetes uses.
|
||||
|
||||
## Building Images
|
||||
|
||||
Building images has a similar feel to existing tools. For example, consider
|
||||
running `kim` from a directory with a `Dockerfile` where the `Dockerfile` is
|
||||
using a scratch image.
|
||||
|
||||
```console
|
||||
❯ kim build .
|
||||
[+] Building 0.1s (4/4) FINISHED
|
||||
=> [internal] load build definition from Dockerfile
|
||||
=> => transferring dockerfile: 31B
|
||||
=> [internal] load .dockerignore
|
||||
=> => transferring context: 2B
|
||||
=> [internal] load build context
|
||||
=> => transferring context: 33B
|
||||
=> CACHED [1/1] ADD anvil-app /
|
||||
```
|
||||
|
||||
`kim` has tags for tagging at the same time as building and other options you've
|
||||
come to expect.
|
||||
|
||||
If you want to tag an existing image you've built you can use the `kim tag`
|
||||
command.
|
||||
BIN
docs/images/windows-notice-1.png
Normal file
BIN
docs/images/windows-notice-1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 75 KiB |
BIN
docs/images/windows-notice-2.png
Normal file
BIN
docs/images/windows-notice-2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 96 KiB |
18
docs/installing.md
Normal file
18
docs/installing.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Installing Rancher Desktop
|
||||
|
||||
Rancher Desktop is delivered as a desktop application. You can download it from
|
||||
the [releases page on GitHub](https://github.com/rancher-sandbox/rd/releases).
|
||||
|
||||
When run for the first time or when changing versions, Kubernetes container
|
||||
images are downloaded. It may take a little time to load on first run for a new
|
||||
Kubernetes version.
|
||||
|
||||
Note, the Windows installer is not yet signed. This will happen soon. In the
|
||||
meantime, when presented with a dialog box like the following, click on "More
|
||||
info".
|
||||
|
||||

|
||||
|
||||
The following dialog will then give you the option to run the application:
|
||||
|
||||

|
||||
Reference in New Issue
Block a user