13
13
<h1 align =" center " > Kube Forwarder</h1 >
14
14
<h3 align =" center " >Easy to use Kubernetes port forwarding manager</h3 >
15
15
<h4 align =" center " >
16
- <a href =" https://kube-forwarder.pixelpoint.io " >Visit a Website</a > ·
17
- <a href =" https://github.com/pixel-point/kube-forwarder/releases/latest/download/kube-forwarder.dmg " >Download for macOS</a > ·
18
- <a href =" https://github.com/pixel-point/kube-forwarder/releases/latest/download/kube-forwarder.exe " >Download for Windows</a > ·
16
+ <a href =" https://kube-forwarder.pixelpoint.io " >Visit a Website</a > ·
17
+ <a href =" https://github.com/pixel-point/kube-forwarder/releases/latest/download/kube-forwarder.dmg " >Download for macOS</a > ·
18
+ <a href =" https://github.com/pixel-point/kube-forwarder/releases/latest/download/kube-forwarder.exe " >Download for Windows</a > ·
19
19
<a href =" https://github.com/pixel-point/kube-forwarder/releases/latest/download/kube-forwarder.AppImage " >Download for Linux</a >
20
20
·
21
21
<a href =" #install-with-homebrew " >Install with Homebrew</a >
22
22
</h4 >
23
23
24
24
25
- ![ Clusters Page] ( https://user-images.githubusercontent.com/2697570/60103100-524d5d80-975f-11e9-84ab-bcc962be0bb7.png )
25
+ ![ Clusters Page] ( https://user-images.githubusercontent.com/2697570/60103100-524d5d80-975f-11e9-84ab-bcc962be0bb7.png )
26
26
27
27
## Features
28
28
@@ -51,46 +51,46 @@ Use port-forwarding without installing kubectl and avoid explanations to develop
51
51
52
52
### Add a cluster(s)
53
53
54
- Before you start forwarding internal resources to your local machine, you have to add cluster configuration.
54
+ Before you start forwarding internal resources to your local machine, you have to add cluster configuration.
55
55
To do this we have 3 different options in the app:
56
56
57
57
1 ) Auto-detection of ~ /.kube/config file and parsing settings from it
58
58
1 ) Manual adding of Kubernetes config by selecting a file(s)
59
59
1 ) Manual adding of Kubernetes config by pasting a text
60
60
1 ) Import of the JSON file that could be generated via Kube Forwarder export functionality
61
61
62
- When you add a new cluster via auto-detection (option 1) or manually using a file(a) selection (option 2), we could parse
63
- configs and if there are multiple contexts inside we will suggest you to add multiple clusters to the app.
62
+ When you add a new cluster via auto-detection (option 1) or manually using a file(a) selection (option 2), we could parse
63
+ configs and if there are multiple contexts inside we will suggest you to add multiple clusters to the app.
64
64
Few examples of yaml files we expect to have you could find [ there] ( https://github.com/pixel-point/kube-forwarder/issues/7 )
65
65
66
66
Also, you could add a cluster by filling a form manually (option 3). The form has the following fields:
67
67
* Name - the name of a cluster withing Kube Forwarder app.
68
68
* Storing method (Set destination to your kube config or paste it as a text) - the method of storing a config It has two options:
69
69
* ` Set a path ` - storing a path to the config file. It will be read every time when you forwarding a port. It allows
70
- a user to don't do any changes in Kube Forwarder's settings when a third-party app updates the config file.
70
+ a user to don't do any changes in Kube Forwarder's settings when a third-party app updates the config file.
71
71
For example, when ` azure-cli ` updates an access token (#13 ).
72
72
* ` Paste as a text ` - storing a config just as a yml text.
73
73
* Path (if storing method is ` Set a path ` ) - the path to a config file.
74
74
* Content (if storing method is ` Paste as a text ` ) - Yml config as a text.
75
75
* Current Context (if storing method is ` Set a path ` ) - When you use ` Set a path ` , you must select a context from a file
76
76
which will be used to connect to a resource. Let's see an example of a problem that the field solves.
77
77
1) Let's say we don't have ` Current context ` field.
78
- 1) A user has a config file with two contexts: ` local-cluster ` and ` remote-cluster ` .
78
+ 1) A user has a config file with two contexts: ` local-cluster ` and ` remote-cluster ` .
79
79
` current-context ` in the yml file is ` local-cluster ` .
80
80
1) The user configured a cluster in Kube Forwarder with ` Set a path ` option.
81
81
1) The user created a resource ` postgres ` and successfully forwarded ports for some time.
82
82
1) Then the user executed ` kubectl config use-context remote-cluster `
83
83
1) If the user tries to forward the resource in Kube Forwarder again, most likely there will be an error
84
84
since a connection will be established with ` remote-cluster ` , not ` local-cluster ` as the user expected,
85
85
and ` remote-cluster ` couldn't have ` postgres ` resource.
86
-
87
- So, to avoid the error we should store the current context in a separate field.
86
+
87
+ So, to avoid the error we should store the current context in a separate field.
88
88
89
89
<a target =" _blank " href =" https://user-images.githubusercontent.com/2697570/60754775-58a4ca80-9fe6-11e9-8d67-d15a1423b506.png " ><img width =" 320 " alt =" Screenshot 2019-07-06 at 12 04 45 " src =" https://user-images.githubusercontent.com/2697570/60754775-58a4ca80-9fe6-11e9-8d67-d15a1423b506.png " ></a >
90
90
91
91
### Add a resource
92
92
93
- Kube Forwarder supports forwarding of all types of resources that supported by ` kubectl ` – Pod, Deployment, Service.
93
+ Kube Forwarder supports forwarding of all types of resources that supported by ` kubectl ` – Pod, Deployment, Service.
94
94
95
95
We ask you to fill the form with the following fields:
96
96
@@ -104,21 +104,21 @@ We ask you to fill the form with the following fields:
104
104
105
105
** Alias** - alternative name of the resource that will be displayed on the homepage(optional)
106
106
107
- ** Port Forwarding**
108
-
107
+ ** Port Forwarding**
108
+
109
109
- ** Local port** - port from your local machine where the resource will be forwarded. Note that ports <= 1024 are
110
110
restricted to user ` root `
111
- - ** Resource port** - port of the resource from the Kubernetes cluster
111
+ - ** Resource port** - port of the resource from the Kubernetes cluster
112
112
113
113
** Use Custom Local Address** - Check this and put an IP address or hostname into the text field to
114
- use a different listen address. Putting each service on its own address avoids sharing/collisions between
115
- services on cookies and port number. Specify a loopback address like ` 127.0.x.x ` or add entries to your
114
+ use a different listen address. Putting each service on its own address avoids sharing/collisions between
115
+ services on cookies and port number. Specify a loopback address like ` 127.0.x.x ` or add entries to your
116
116
hosts file like ` 127.0.1.1 dashboard.production.kbf ` and put the assigned name in this column. If blank or
117
117
unchecked, ` localhost ` / ` 127.0.0.1 ` will be used.
118
118
119
119
<a target =" _blank " href =" https://user-images.githubusercontent.com/2697570/60754738-e207cd00-9fe5-11e9-95b3-8f4704ca3dce.png " ><img width =" 320 " alt =" Port Forwarding Form " src =" https://user-images.githubusercontent.com/2697570/60754738-e207cd00-9fe5-11e9-95b3-8f4704ca3dce.png " ></a >
120
120
121
- ### Import/Export
121
+ ### Import/Export
122
122
123
123
Kube Forwarder allows you export cluster configuration in JSON that you could use to share with your team members or for the backup purpose. You could easily store it on Github. When you export cluster, you could export it with or without confidential information.
124
124
@@ -134,8 +134,8 @@ brew cask install kube-forwarder
134
134
135
135
We encourage you to contribute to Kube Forwarder!
136
136
137
- We expect contributors to abide by our underlying [ code of conduct] ( ./.github/CODE_OF_CONDUCT.md ) .
138
- All conversations and discussions on GitHub (issues, pull requests)
137
+ We expect contributors to abide by our underlying [ code of conduct] ( ./.github/CODE_OF_CONDUCT.md ) .
138
+ All conversations and discussions on GitHub (issues, pull requests)
139
139
must be respectful and harassment-free.
140
140
141
141
This project was generated with [ electron-vue] ( https://github.com/SimulatedGREG/electron-vue ) @[ 8fae476] ( https://github.com/SimulatedGREG/electron-vue/tree/8fae4763e9d225d3691b627e83b9e09b56f6c935 ) using [ vue-cli] ( https://github.com/vuejs/vue-cli ) . Documentation about the original structure can be found [ here] ( https://simulatedgreg.gitbooks.io/electron-vue/content/index.html ) .
@@ -200,7 +200,7 @@ npm run build:dist
200
200
npm run build:target -- --win
201
201
```
202
202
203
- A built version will be appear in ` build ` directory.
203
+ A built version will be appear in ` build ` directory.
204
204
205
205
## Running the tests
206
206
@@ -224,6 +224,14 @@ npm run test:cypress:onhost
224
224
npm run test:cypress:open
225
225
```
226
226
227
+ ## Troubleshooting
228
+
229
+ Q) Node Sass could not find a binding for your current environment: OS X 64-bit with Node.js 12.x
230
+ A) ` npm rebuild node-sass `
231
+
232
+ Q) Error: spawn .../kube-forwarder/node_modules/electron/dist/Electron.app/Contents/MacOS/Electron ENOENT
233
+ A) Reinstall node_modules: ` rm -rf node_modules && npm i `
234
+
227
235
## Release guide
228
236
229
237
### Configure environment
@@ -236,18 +244,18 @@ Also, this steps could be used to configure CI environment.
236
244
237
245
1 ) Update the version in ` package.json ` and Push to ` release ` branch.
238
246
1 ) Run ` npm run release ` on a Mac computer to build packages. They will be automatically pushed to releases at Github.
239
- 1 ) Go to [ Releases] ( https://github.com/pixel-point/kube-forwarder/releases ) in the repository.
247
+ 1 ) Go to [ Releases] ( https://github.com/pixel-point/kube-forwarder/releases ) in the repository.
240
248
Make sure that the created draft is OK and release it (Edit -> Release).
241
249
1 ) Run ` cask-repair kube-forwarder ` to update the cask version.
242
- ([ https://github.com/Homebrew/homebrew-cask/blob/master/CONTRIBUTING.md#updating-a-cask ] (About cask-repair))
250
+ ([ https://github.com/Homebrew/homebrew-cask/blob/master/CONTRIBUTING.md#updating-a-cask ] (About cask-repair))
243
251
244
- Notes:
252
+ Notes:
245
253
1 ) A release tag (for example: ` v1.0.3 ` ) will be added to GIT automatically by Github when you release your draft.
246
254
247
255
## Development tips
248
256
249
257
Use
` tiffutil -cathidpicheck bg.png [email protected] -out bg.tiff ` to build a tiff
250
- background for .DMG
258
+ background for .DMG
251
259
252
260
## Supported by
253
261
<table >
@@ -258,7 +266,7 @@ background for .DMG
258
266
<td valign =" middle " ><a href =" https://sentry.io/ " ><img width =" 200px " src =" https://user-images.githubusercontent.com/2697570/60827162-dd8f1000-a1af-11e9-9536-0bba6c71778c.png " /></a ></td >
259
267
</tbody >
260
268
</table >
261
-
269
+
262
270
263
271
## License
264
272
0 commit comments