You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Kaptn is a fully downloadable desktop application that provides a user-friendly terminal interface for developers to interact with Kubernetes. With pre-selected kubectl options and the ability to free-type commands, Kaptn provides the training wheels you need to gain familiarity and proficiency in K8s.
29
+
23
30
## Features
31
+
24
32
- User-friendly terminal interface
25
33
- Take command of the command line interface with pre-selected kubectl options, or free-type
26
34
- Clearly visualize the commands within our interactive terminal
@@ -32,63 +40,97 @@ Kaptn is a fully downloadable desktop application that provides a user-friendly
32
40
- Connect with Grafana and Prometheus to monitor cluster health
33
41
- Troubleshoot any confusion with the Instant Help Desk
34
42
- Follow tutorials and master K8s with our Learning Center
43
+
35
44
## Getting Started
45
+
36
46
1. Download the latest release [here](https://github.com/oslabs-beta/kaptn/releases).
37
47
2. Run the installer.
38
-
If you get a warning that the app is from an unidentified developer, go to System Preferences > Security & Privacy > General and click “Open Anyway”.
48
+
49
+
If you get a warning that the app is from an unidentified developer, go to System Preferences > Security & Privacy > General and click "Open Anyway".
50
+
39
51
\*Please note, login functionality is currently disabled. Instead, please continue as guest to access all features of Kaptn.
52
+
40
53
## Usage Guidelines
54
+
41
55
### Overview
56
+
42
57
Our application defaults to our dashboard page, where you will be able to select a folder from your local system as the current working directory. From there, you can choose from the pre-suggested commands—including kubectl—to manage your kubernetes clusters or free-type in the command line interface. You can click on the ‘run’ button to run your command, or the ‘clear’ button to wipe the command line.
- Before you begin to configure your docker and kubernetes, you will need a docker image. You may create your own docker image by defining that image in a dockerfile. For the purposes of this tutorial, however, select an existing image from an online registry, such as dockerhub
49
68
- Navigate to (https://hub.docker.com) on your browser and create an account / sign in
50
69
- Upon entering the dockerhub dashboard, use the search bar or the explore page to look up an image
51
-
- After selecting an image, click on ‘Tags’ to view all tag labels attached
70
+
- After selecting an image, click on 'Tags' to view all tag labels attached
52
71
- In the terminal you opened up in step 2, run docker pull <imagename:tagname>
53
72
- Type out the full image name with the tag into the Image Input Field and press the Enter key
54
73
- You may move onto step 4 once you see the image name render on the screen
- Click on the CREATE .YAML FILE button, which will open up a page for you to set up your yaml file
62
87
- Using the interactive .yaml generator, configure your file accordingly (e.g. deployment, deployment strategy, volume, DNS). You will be able to preview your code on the right side of the page as you make changes
63
88
- Once complete, copy the yaml file by clicking the Copy to Clipboard button in the top right corner
64
89
- Paste your code into the Name input field in the following format and press enter or click run:
65
90
echo ‘YOUR CODE’ > FILENAME.yaml
66
91
- Use your OS finder / files to locate the yaml file you created and confirm that it is configured as you expect
0 commit comments