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
Copy file name to clipboardexpand all lines: README.md
+18-18
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# The F5 VSCode Extension
2
2
3
-
Let the F5 VSCode Extension supercharge your abilities to write (A)utomated (T)ool(C)hain declarations with snippets, examples and declaration schema validation, and also assist with connecting, deploying, retrieving and updating declarations on F5 devices.
3
+
Let the F5 VSCode Extension supercharge your abilities to write (A)utomated (T)ool(C)hain declarations with snippets, examples, and declaration schema validation, and also assist with connecting, deploying, retrieving and updating declarations on F5 devices.
4
4
5
5
It can also help with iRules/iApps, BIG-IQ, and regular configuration/migration.
6
6
@@ -11,9 +11,9 @@ It can also help with iRules/iApps, BIG-IQ, and regular configuration/migration.
11
11
- Convert JSON <-> YAML
12
12
- Hovers to view decoded information for (certificates/base64)
13
13
- Extract TMOS applications (per virtual server)
14
-
- Write, deploy and modify iRules/iApps (with vscode-irule extension for language support)
14
+
- Write, deploy, and modify iRules/iApps (with vscode-irule extension for language support)
15
15
16
-
!> Any comments, questions or feature requests, please open an issue!
16
+
!> Any comments, questions, or feature requests, please open an issue!
17
17
18
18
## Documentation site
19
19
@@ -59,15 +59,15 @@ Select `Add Host` in the `F5: Hosts` view. Then type in device details in the \
59
59
60
60
Click on the hostname of the connected device at the bottom of the window.
61
61
62
-
> This is the easiest way to get an editor window for JSON files and it also demontrates how to get device details
62
+
> This is the easiest way to get an editor window for JSON files and it also demonstrates how to get device details
63
63
64
-
Now that we have a json editor, select all text (`control + a`), then `delete`.
64
+
Now that we have a JSON editor, select all text (`ctrl + a`), then `delete`.
65
65
66
-
Type `as3` to get the example AS3 snippet, press `Enter`.
66
+
Type `as3` to get the example AS3 snippet, then press `Enter`.
67
67
68
68
This should insert a sample AS3 declaration into the editor
69
69
70
-
> Note the declaration schema reference at the top. This provides instant feedback and validation for any necssary modifications. Please see [Schema Validation](schema_validation.md) for more details
70
+
> Note the declaration schema reference at the top. This provides instant feedback and validation for any necessary modifications. Please see [Schema Validation](schema_validation.md) for more details
71
71
72
72
Right-click in the editor and select `POST as AS3 Declaration`. This should post the declaration to the currently connected device
73
73
@@ -87,15 +87,15 @@ Right-click on the tenant in the AS3 view on the left, then select `Delete Tenan
87
87
88
88
HTTP/422 responses - Can happen for a handful of reasons:
89
89
90
-
- Getting DO declaration when device has settings DO can configure but device was not deployed with DO (it can't manage the settings that are already there)
90
+
- Getting DO declaration when the device has settings DO can configure but the device was not deployed with DO (it can't manage the settings that are already there)
91
91
- Improperly formatted/wrong declaration
92
92
- Sometimes this is from the '$schema' reference in the declaration
93
93
- Sometimes you can fix a DO HTTP/400 response by overwriting with a clean/updated declaration
94
94
95
95
96
96
### HTTP Auth Failures
97
97
98
-
When utilizing an external auth provider, occasionally restjavad/restnoded can have some issues, resulting in some occansional HTTP/400 auth errors:
98
+
When utilizing an external auth provider, restjavad/restnoded can have some issues, resulting in some occasional HTTP/400 auth errors:
99
99
100
100
The fix is to restart: restjavad and restnoded
101
101
@@ -125,36 +125,36 @@ Error from restjavad log
125
125
126
126
---
127
127
128
-
## Clientside extension debugging
128
+
## Client-side extension debugging
129
129
130
130
### Developer Debugger
131
131
132
-
VScode has a builtin debugger very much like Chrome. This can be used to gain insight to what is happening when things don't respond as expected.
132
+
VScode has a built-in debugger very much like Chrome. This can be used to gain insight into what is happening when things don't respond as expected.
133
133
134
134
If you are having issues, it may be best to start here and capture the output as described below:
135
135
136
-
- In the main VSCode window, along the top, select **Help**, then **Toggle Developer Tools**, select the **Console** tab.
136
+
- In the main VSCode window, along the top, select **Help**, then **Toggle Developer Tools**, then select the **Console** tab.
137
137
- Then, explore the requests and responses to see if there are any areas of concern
138
-
- Expand some of the objects by clicking the little triangle next to the obejct under a request or response to inspect
138
+
- Expand some of the objects by clicking the little triangle next to the object under a request or response to inspect
139
139
140
140
If needed, **right-click** on an entry, then select **save-as** to save the log including expanded objects to a file. This can be used for troubleshooting
This mainly catches logs send through the console.log(''), which should typically be for development.
145
+
This mainly catches logs sent through the console.log(''), which should typically be for development.
146
146
147
147
148
148
## installing vsix
149
149
150
-
The recommended way to get this extension is to install from the Microsoft VScode extension marketplace or from within VSCode directly, under the extensions activity bar view on the left.
150
+
The recommended way to get this extension is to install it from the Microsoft VScode extension marketplace or from within VSCode directly, under the extensions activity bar view on the left.
151
151
152
152
If you still need to install from vsix, they can be downloaded under the 'release' tab above: <https://github.com/f5devcentral/vscode-f5/releases>
0 commit comments