Commit Graph

298 Commits

Author SHA1 Message Date
Czar Echavez
76e954d1a1 Merge remote-tracking branch 'origin/dev' into feature/1847-more-red-agents 2024-06-11 14:26:11 +01:00
Archer.Bowen
146afea44f Updated copyright clause on .rst 2024-06-07 16:44:33 +01:00
Archer.Bowen
2954ca966f Updated core user guide to match exactly that of 3.0.0/internal. 2024-06-07 16:35:33 +01:00
Chris McCarthy
3c17ef0a69 #2628 - added _can_perform_network_action to nmap.py. made some changes following PR suggestions. 2024-06-04 22:29:00 +01:00
Archer.Bowen
71e0c4179e Merge branch 'user-guide-feedback-core-fixes' of https://dev.azure.com/ma-dev-uk/PrimAITE/_git/PrimAITE into user-guide-feedback-core-fixes 2024-06-03 15:51:55 +01:00
Archer.Bowen
18e6886381 User guide updates 2024-06-03 15:51:14 +01:00
Marek Wolan
2406579c78 format using precommit 2024-05-31 18:50:56 +01:00
Archer.Bowen
9f0c6ddbb4 Fix primaite dependencies formatting issue 2024-05-31 18:18:40 +01:00
Archer.Bowen
93a729029c Merge remote-tracking branch 'origin/dev' into user-guide-feedback-core-fixes 2024-05-31 17:13:27 +01:00
Archer.Bowen
0ac57147cd Updated index following new primAITE 2 Pager 2024-05-31 17:05:30 +01:00
Marek Wolan
f9cff42856 glossary fact check 2024-05-31 16:03:47 +01:00
Marek Wolan
97d4c38298 remove tests from api docs 2024-05-31 15:56:27 +01:00
Chris McCarthy
4d61e857df dropped the automatic creation of primaite-dependencies.rst and made it manual as we now only need immediate dependencies 2024-05-31 15:42:41 +01:00
Marek Wolan
4ee29d129d Fix firewall diagram 2024-05-31 15:41:40 +01:00
Archer.Bowen
efc4e3e9b0 Core User Guide Feeedback Implemented.
Feedback Issues left:

1.Issues with red-agent image not embeded correctly in data_manipulation_e2e notebook

2._autosummary/tests.unit_tests.html is still completely blank.

3. _index.html is not updated with new 2-pager

4. _dependencies is not updated to just include tier-1 and primary for v3.

5. definiton of user_app_home is not confirmed
2024-05-31 13:55:20 +01:00
Chris McCarthy
5eea5bf4f9 #2618 - Integrated the NMAP into the action and requests functionality to enable agent usage. added NMAP agents tests. 2024-05-31 13:53:18 +01:00
Marek Wolan
0c19546322 #2588 optional RL deps 2024-05-29 14:54:45 +01:00
Chris McCarthy
9c4d47b0b9 #2618 - Fixed up some formatting in the nmap.rst documentation 2024-05-29 13:29:08 +01:00
Chris McCarthy
716f3ece1e #2618 - Added NMAP application, documentation, and tests. 2024-05-29 13:13:42 +01:00
Charlie Crane
85f03570f7 Merged PR 376: 2457 - Remove Hardcoding from Links
## Summary
This PR removes the hardcoding of Link bandwidth, and makes it possible to be configured via the network yaml definitions.
Link bandwidth will still default to 100 if this is not present, to prevent breaking all previous defined networks.

## Test process
All tests continue to pass.
`basic_network_config.yaml` now provides a non-default link bandwidth which is confirmed within unit tests.

## Checklist
- [X] PR is linked to a **work item**
- [X] **acceptance criteria** of linked ticket are met
- [X] performed **self-review** of the code
- [X] written **tests** for any new functionality added with this PR
- [X] updated the **documentation** if this PR changes or adds functionality
- [ ] written/updated **design docs** if this PR implements new functionality
- [] updated the **change log**
- [X] ran **pre-commit** checks for code style
- [X] attended to any **TO-DOs** left in the code

Related work items: #2457
2024-05-22 11:35:48 +00:00
Charlie Crane
a759a6f5c3 #2457 - Addressing review comments 2024-05-20 16:52:17 +01:00
Czar Echavez
8e17151696 #2472: apply PR suggestions 2024-05-17 11:17:00 +01:00
Czar Echavez
7530b5b7a6 #2472: prevent notebook outputs when building documentation 2024-05-16 15:36:40 +01:00
Czar Echavez
fb7571ceae #2472: apply PR suggestions + minor fixes to make the notebooks output beautifuller 2024-05-16 14:06:43 +01:00
Czar Echavez
82953b4b0a #2472: add install pandoc to docs build pipeline + fix RLlib running for a long time 2024-05-16 10:55:17 +01:00
Czar Echavez
d2cf0f2d22 #2472: revert make.bat changes 2024-05-15 14:03:17 +01:00
Czar Echavez
f7de3e6425 #2472: clean up 2024-05-15 14:00:14 +01:00
Charlie Crane
f66d9d5817 Merge branch 'dev' into feature/2457-Set_link_bandwidth_via_config 2024-05-14 14:44:20 +01:00
Charlie Crane
74514e977d #2457 - Syncing changes made. Updates to documentation and tests 2024-05-14 11:05:37 +01:00
Czar Echavez
2774623fba #2472: switch to using nbsphinx + added readme steps to setup pandoc + revert changes 2024-05-14 07:36:29 +01:00
Czar Echavez
795004be5b #2472: copy image assets + applying change to makefile 2024-05-09 14:16:29 +01:00
Czar Echavez
81c523dc67 #2472: integrating jupyter notebooks into documentation 2024-05-09 13:43:55 +01:00
Czar Echavez
25807653f4 Merge remote-tracking branch 'origin/dev' into feature/2533-improve-dev-tools-in-primaite-cli 2024-05-01 16:11:52 +01:00
Czar Echavez
61e7a4e439 #2533: documentation on use of dev-mode 2024-05-01 16:04:18 +01:00
Chris McCarthy
7552872430 #2519 - Fixed the broked multi-lan network topology diagrams while I was in doing a PR too 2024-05-01 10:28:54 +01:00
Czar Echavez
73f64cd89c Merge remote-tracking branch 'origin/dev' into feature/2533-improve-dev-tools-in-primaite-cli 2024-04-30 18:27:05 +01:00
Christopher McCarthy
a82ee2b8e1 Merged PR 354: Network focussed dev config documentation
## Summary
Built three networks, one is the minimal network, one is a basic LAN, and another is a nice beefy multi-LAN setup with ISP and DNS along with applications, services. Documented the process when building the config files. Included the config files as example configs for use.

## Test process
Tested the shit out of the big multi-lan network.

## Checklist
- [ ] PR is linked to a **work item**
- [ ] **acceptance criteria** of linked ticket are met
- [ ] performed **self-review** of the code
- [ ] written **tests** for any new functionality added with this PR
- [ ] updated the **documentation** if this PR changes or adds functionality
- [ ] written/updated **design docs** if this PR implements new functionality
- [ ] updated the **change log**
- [ ] ran **pre-commit** checks for code style
- [ ] attended to any **TO-DOs** left in the code

Related work items: #2266
2024-04-30 13:53:28 +00:00
Chris McCarthy
a141c8d212 #2266 - fixed typos from PR suggestions 2024-04-30 14:08:12 +01:00
Czar Echavez
c94fa653f7 Merge remote-tracking branch 'origin/dev' into feature/2533-improve-dev-tools-in-primaite-cli 2024-04-29 16:24:19 +01:00
Czar Echavez
a7492ba39f #2447: cli commands for dev mode 2024-04-29 13:45:10 +01:00
Marek Wolan
3c046b838b #2514 Document request response. 2024-04-29 11:11:51 +01:00
Chris McCarthy
81d4006240 #2266 - Finalised the tests and fleshed out the documentation more. 2024-04-26 23:18:09 +01:00
Marek Wolan
394e76048f Merge remote-tracking branch 'origin/dev' into feature/2476-training-schedules-mockup 2024-04-26 16:23:41 +01:00
Chris McCarthy
0ccd53e907 Merge branch 'dev' into feature/2266_network-focussed-dev-documentation 2024-04-26 16:19:33 +01:00
Charlie Crane
5ee23dcb17 Merged PR 348: #2462 - Refactor of DatabaseClient and DatabaseServer
## Summary
Refactor of `DatabaseClient` and `DatabaseService` to update how connection IDs are generated. These are now provided by DatabaseService when establishing a connection.
Creation of `DatabaseClientConnection` class. This is used by `DatabaseClient` to hold a dictionary of active db connections.

## Test process
Tests have been updated to reflect the changes and all pass

## Checklist
- [X] PR is linked to a **work item**
- [X] **acceptance criteria** of linked ticket are met
- [X] performed **self-review** of the code
- [X] written **tests** for any new functionality added with this PR
- [X] updated the **documentation** if this PR changes or adds functionality
- [ ] written/updated **design docs** if this PR implements new functionality
- [X] updated the **change log**
- [X] ran **pre-commit** checks for code style
- [X] attended to any **TO-DOs** left in the code

Related work items: #2462
2024-04-26 14:52:21 +00:00
Chris McCarthy
058ca3987f #2266 - Added more docs. Now need to test 2024-04-26 14:32:54 +01:00
Marek Wolan
be5cf0b877 Merge remote-tracking branch 'origin/dev' into feature/2476-training-schedules-mockup 2024-04-25 15:17:08 +01:00
Chris McCarthy
0fff7d2240 Merge branch 'dev' into feature/2266_network-focussed-dev-documentation 2024-04-25 15:16:28 +01:00
Chris McCarthy
c93c432bf1 #2266 - Added final complex network to the examples. Just need to finalise the building the config section 2024-04-25 15:14:40 +01:00
Marek Wolan
736408f8b4 Reference the episode schedule notebook in docs 2024-04-25 15:12:46 +01:00