Skip to content

Commit

Permalink
9.18.2024 work (#257)
Browse files Browse the repository at this point in the history
  • Loading branch information
DumpySquare authored Sep 18, 2024
1 parent 79f5f71 commit db1405c
Show file tree
Hide file tree
Showing 18 changed files with 3,599 additions and 73 deletions.
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ node_modules

# ignore ilx rpm cache directory
atc_ilx_rpm_cache
cache
.vscode-test/
# ignore any extension install files and zips
*.vsix
Expand All @@ -25,3 +24,8 @@ cache
mini_ucs.tar.gz
# ignore node cpu profiling outputs
*.cpuprofile
# ignore big dev files in cache
cache/*.rpm
cache/*.sha256
cache/*.qkview
cache/*.ucs
16 changes: 15 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,20 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how

---

## [3.17.0] - (09-20-2024)

### Fixed

- [BUG] Schema validation is using the wrong path #255
- [BUG] V3.16.x ATC Package management broken #249
- [PR] Update package.json #256
- [PR] Update tmosXcRules.json #252
- [PR] Update tmosXcRules.json - VDI support #251
- [PR] Update tmosXcRules.json #250
- [PR] Update README.md #227

---

## [3.16.1] - (02-27-2024)

### Fixed
Expand Down Expand Up @@ -800,7 +814,7 @@ The main purpose behind this major release is a complete overhaul of the underly
- included options for redeploying iApp-App with current paramters and deleting an iApp-App
- `Merge TCL/TMOS` can be used to merge ANY TMOS config item

Documentation: <https://github.com/f5devcentral/vscode-f5/blob/master/README_docs/tcl.md>
Documentation: <https://github.com/f5devcentral/vscode-f5/blob/HEAD/README_docs/tcl.md>

### Modified

Expand Down
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# The F5 VSCode Extension

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.
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.

It can also help with iRules/iApps, BIG-IQ, and regular configuration/migration.

Expand All @@ -11,9 +11,9 @@ It can also help with iRules/iApps, BIG-IQ, and regular configuration/migration.
- Convert JSON <-> YAML
- Hovers to view decoded information for (certificates/base64)
- Extract TMOS applications (per virtual server)
- Write, deploy and modify iRules/iApps (with vscode-irule extension for language support)
- Write, deploy, and modify iRules/iApps (with vscode-irule extension for language support)

!> Any comments, questions or feature requests, please open an issue!
!> Any comments, questions, or feature requests, please open an issue!

## Documentation site

Expand Down Expand Up @@ -59,15 +59,15 @@ Select `Add Host` in the `F5: Hosts` view. Then type in device details in the \

Click on the hostname of the connected device at the bottom of the window.

> This is the easiest way to get an editor window for JSON files and it also demontrates how to get device details
> This is the easiest way to get an editor window for JSON files and it also demonstrates how to get device details
Now that we have a json editor, select all text (`control + a`), then `delete`.
Now that we have a JSON editor, select all text (`ctrl + a`), then `delete`.

Type `as3` to get the example AS3 snippet, press `Enter`.
Type `as3` to get the example AS3 snippet, then press `Enter`.

This should insert a sample AS3 declaration into the editor

> 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
> 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
Right-click in the editor and select `POST as AS3 Declaration`. This should post the declaration to the currently connected device

Expand All @@ -87,15 +87,15 @@ Right-click on the tenant in the AS3 view on the left, then select `Delete Tenan

HTTP/422 responses - Can happen for a handful of reasons:

- 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)
- 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)
- Improperly formatted/wrong declaration
- Sometimes this is from the '$schema' reference in the declaration
- Sometimes you can fix a DO HTTP/400 response by overwriting with a clean/updated declaration


### HTTP Auth Failures

When utilizing an external auth provider, occasionally restjavad/restnoded can have some issues, resulting in some occansional HTTP/400 auth errors:
When utilizing an external auth provider, restjavad/restnoded can have some issues, resulting in some occasional HTTP/400 auth errors:

The fix is to restart: restjavad and restnoded

Expand Down Expand Up @@ -125,36 +125,36 @@ Error from restjavad log

---

## Client side extension debugging
## Client-side extension debugging

### Developer Debugger

VScode has a built in debugger very much like Chrome. This can be used to gain insight to what is happening when things don't respond as expected.
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.

If you are having issues, it may be best to start here and capture the output as described below:

- In the main VSCode window, along the top, select **Help**, then **Toggle Developer Tools**, select the **Console** tab.
- In the main VSCode window, along the top, select **Help**, then **Toggle Developer Tools**, then select the **Console** tab.
- Then, explore the requests and responses to see if there are any areas of concern
- Expand some of the objects by clicking the little triangle next to the obejct under a request or response to inspect
- Expand some of the objects by clicking the little triangle next to the object under a request or response to inspect

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

<!-- ![vscode debugging console](./README_docs/images/vscodeDebugConsole_5.20.2020.PNG) -->
<img src="./README_docs/images/vscodeDebugConsole_5.20.2020.PNG" alt="drawing" width="80%"/>

This mainly catches logs send through the console.log(''), which should typically be for development.
This mainly catches logs sent through the console.log(''), which should typically be for development.


## installing vsix

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.
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.

If you still need to install from vsix, they can be downloaded under the 'release' tab above: <https://github.com/f5devcentral/vscode-f5/releases>

Different ways to install vsix:

- <https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix>
- <https://github.com/eamodio/vscode-gitlens/wiki/Installing-Prereleases-(vsix>)
- <https://github.com/eamodio/vscode-gitlens/wiki/Installing-Prereleases-(vsix)>


## Running the extension for dev
Expand All @@ -170,8 +170,8 @@ Different ways to install vsix:

- Start Debugging environment: Keystroke `F5`
- Navigate to view container by clicking on the f5 icon in the Activity bar (typically on the left)
- Update device list in tree view on the left with a device in your environment
- Update the device list in tree view on the left with a device in your environment
- ***ADD*** in the ***F5 Hosts*** view
- or `click` the pencil icon on an item and modify the item
- Connect to device
- Connect to the device
- (`click` device in host tree or `Cntrl+shift+P` or `F1`)
12 changes: 6 additions & 6 deletions README_docs/schemaValidation.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,13 +89,13 @@ https://code.visualstudio.com/docs/editor/userdefinedsnippets
<p>&nbsp;</p>

### Latest AS3 Schema
https://raw.githubusercontent.com/F5Networks/f5-appsvcs-extension/master/schema/latest/as3-schema.json
https://raw.githubusercontent.com/F5Networks/f5-appsvcs-extension/main/schema/latest/as3-schema.json

### Latest DO Schema
https://raw.githubusercontent.com/F5Networks/f5-declarative-onboarding/master/src/schema/latest/base.schema.json
https://raw.githubusercontent.com/F5Networks/f5-declarative-onboarding/HEAD/src/schema/latest/base.schema.json

### Latest TS Schema
https://raw.githubusercontent.com/F5Networks/f5-telemetry-streaming/master/src/schema/latest/base_schema.json
https://raw.githubusercontent.com/F5Networks/f5-telemetry-streaming/HEAD/src/schema/latest/base_schema.json

<p>&nbsp;</p>

Expand All @@ -117,9 +117,9 @@ In the vscode settings for that extension:

```json
"yaml.schemas": {
"https://raw.githubusercontent.com/F5Networks/f5-appsvcs-extension/master/schema/latest/as3-schema.json": ["*.as3.yml"],
"https://raw.githubusercontent.com/F5Networks/f5-declarative-onboarding/master/src/schema/latest/base.schema.json": ["*.do.yml"],
"https://raw.githubusercontent.com/F5Networks/f5-telemetry-streaming/master/src/schema/latest/base_schema.json": ["*.ts.*"],
"https://raw.githubusercontent.com/F5Networks/f5-appsvcs-extension/main/schema/latest/as3-schema.json": ["*.as3.yml"],
"https://raw.githubusercontent.com/F5Networks/f5-declarative-onboarding/HEAD/src/schema/latest/base.schema.json": ["*.do.yml"],
"https://raw.githubusercontent.com/F5Networks/f5-telemetry-streaming/HEAD/src/schema/latest/base_schema.json": ["*.ts.*"],
}
```
<p>&nbsp;</p>
Expand Down
Loading

0 comments on commit db1405c

Please sign in to comment.