Skip to content

Commit

Permalink
documentation-folder-reorg (#230)
Browse files Browse the repository at this point in the history
* sync-with-azure-dash (#8)

* dash-holistic-view (#104)

* draft document

* Updated content and images

* added image and updated content

* fixed image

* Update dash-architecture.md

* Fixed image and caption

* Update dash-architecture.md

* added/reorganized images

* Update dash-architecture.md

* fixed image and content

* Update dash-architecture.md

* Update dash-hld-ecosystem.svg

* Renamed file.

* Update dash-hld-ecosystem.svg

* Update dash-hld-ecosystem.svg

* Update dash-architecture-view.md

* Update dash-hld-ecosystem.svg

* Update dash-architecture-view.md

* Update dash-architecture-view.md

* Update dash-architecture-view.md

* Update dash-architecture-view.md

* reorganized content

* Update dash-architecture-view.md

* Update dash-architecture-view.md

* Fixed images and content based on feedback

* move images, added captions, fixed content

* Update dash-hld-project-ecosystem.svg

* Update dash-architecture-view.md

* Update dash-architecture-view.md

* Update dash-architecture-view.md

Fixed the "SONiC integration" section and linked to Prince's doc "dash-sonic-hld.md".

* Update dash-architecture-view.md

* fixed card opacity

* Update dash-architecture-view.md

* Update dash-architecture-view.md

* Update dash-architecture-view.md

* Update dash-architecture-view.md

* Fixed image

* fixed image

* fixed image and related content

* Update dash-architecture-view.md

* Update dash-architecture-view.md

* Update dash-architecture-view.md (#3)

Merged in the PR: mmiele#2.

* Renamed article and added content.

* Update dash-architecture-view.md

* Update dash-architecture-view.md

* Update dash-architecture-view.md

* Update dash-architecture-view.md

* renamed file

* Update dash-holistic-view.md

* Update dash-holistic-view.md

* Update dash-holistic-view.md

* Update dash-holistic-view.md

* Update dash-holistic-view.md

* Update dash-holistic-view.md

* fixed formating

* Update dash-holistic-view.md

* Update dash-holistic-view.md

* Update dash-holistic-view.md

* Fixed images

* Fixed TOC

* Update documentation/general/design/dash-holistic-view.md

Co-authored-by: KrisNey-MSFT <[email protected]>

* Update documentation/general/design/dash-holistic-view.md

Co-authored-by: KrisNey-MSFT <[email protected]>

* Apply suggestions from code review

Co-authored-by: KrisNey-MSFT <[email protected]>

* Apply suggestions from code review

Co-authored-by: KrisNey-MSFT <[email protected]>

* Updated content and added note

* Fixed content

* fixed metadata

* Created .gitignore and removed bkp files

* Fixed content based on feedback.

* Fixed content based on feedback. Added links and special notes.  Fixed image.

* Fixed diagrams: using gNMI container instead of DASH container.

* Fixed title and typos

* Added reference links

* Update documentation/general/design/dash-holistic-view.md

Change committed.

Co-authored-by: KrisNey-MSFT <[email protected]>

* Update dash-high-level-smart-switch.svg

Changed "DASH container" name to "gNMI container".

* Fixed image and moved `.gitignore` to the main folder.

* Apply suggestions from code review

Committed Kristina's suggestions.

Co-authored-by: KrisNey-MSFT <[email protected]>

* Update dash-holistic-view.md

Renamed the section API to "SAI headers and behavioral model". Added links to the related README files.

* Removed old dash-high-level-design.md

deleted dash-high-level-design.md
renamed dash-holistic-view.md to dash-high-level-design.md

* Added the list of words to generate the "word cloud".

* Update README.md

Reversed the link order and fixed descriptions.

Co-authored-by: KrisNey-MSFT <[email protected]>

* Update dash-high-level-design.md

* Update dash-high-level-design.md

* Update dash-hld-project-ecosystem.svg

* Update dash-high-level-design.md

Co-authored-by: KrisNey-MSFT <[email protected]>

* Create sdn-packet-transforms-vm-to-vm.svg

Edited Fast Path and Slow Path images

* Reorganized dataplane folder.

* Fixed links

* Reorganized gnmi folder.

* Reorganized encrypt-gw-service and express-route-service folders

* Reorganized general folder

* Fixed link

* Reorganized high-avail folder.

* Reorganized load-bal-service folder

* Reorganized sai folder.

* Reorganized stpl-service folder.

* Reorganized vnet-peering-service folder.

* Reorganized vnet-to-vnet-service folder.

* Fixed reference links.

* Fixed links to point to the reorganized folders.

* Update vnet-to-vnet-service.md

Updated metadata

* Squashed commit of the following:

commit 9700152
Merge: 32332b5 d003f4e
Author: Michael Miele <[email protected]>
Date:   Sat Sep 17 16:43:45 2022 -0700

    Merge branch 'Azure:main' into main

commit d003f4e
Author: Chris Sommers <[email protected]>
Date:   Fri Sep 16 22:43:03 2022 -0700

    Upgrade to ixia-c 0.0.1-3383 (#226)

    * Upgrade to ixia-c 0.0.1-3383 which fixes hairpin mode and adds option to disable IPv6 at launch.
    Remove ./disable_veth_ipv6.sh from makefile after deploy-ixiac sincve it's not needed. (Keep it as prerequisite to running test-cases since we still need to prevent linux ICMP6 packets during tests.)

    * Update ixia-c traffic engine to match controller.

    * Update snappi version to match ixia-c-components.

    Co-authored-by: Chris Sommers <[email protected]>

commit 543df5c
Author: Ze Gan <[email protected]>
Date:   Fri Sep 16 01:36:01 2022 +0800

    [doc]: Fix the typo of TCP UDP protocol number (#223)

    According to: https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml, the ptotocol number of TCP should be 6, and the UDP's should be 17.

commit 94b0168
Author: Chris Sommers <[email protected]>
Date:   Wed Sep 14 10:27:22 2022 -0700

    Slide deck for today's SAI Challenger presentation

commit 10056d7
Author: KrisNey-MSFT <[email protected]>
Date:   Mon Sep 12 16:33:36 2022 -0700

    Update .wordlist.txt

commit f1c5245
Author: KrisNey-MSFT <[email protected]>
Date:   Mon Sep 12 16:31:16 2022 -0700

    Fix Spelling (#221)

    * Update AMD-Pensando_HA_Proposal.md

    Explicitly add 'parallel' to state synchronization stages (per @lguohan )

    * Update AMD-Pensando_HA_Proposal.md (#210)

    * SAI apigen support for tables with no action parameters and a single action (#207)

    * Update .wordlist.txt

    * Update AMD-Pensando_HA_Proposal.md

    * Doc dash as submodule (#203)

    * Document third-party workflows using DASH as a Git submodule.

    * Add URL to sample project.

    * Incorporate review feedback (typo; missing file).

    * Spellcheck fixes.

    * Spellcheck

    * Add .wordlist.txt to CI triggers.

    * Spellcheck wordlist.

    Co-authored-by: Chris Sommers <[email protected]>

    * Split SAI API (#201)

    Make APIs compatible with SONiC bulk infra

    Signed-off-by: Marian Pritsak <[email protected]>

    * Add APP_DB to SAI mapping (#102)

    * Add APP_DB to SAI mapping

    * Update .wordlist.txt

    Updating w/Chris

    Signed-off-by: Marian Pritsak <[email protected]>
    Co-authored-by: Mukesh Moopath Velayudhan <[email protected]>
    Co-authored-by: Chris Sommers <[email protected]>
    Co-authored-by: Chris Sommers <[email protected]>
    Co-authored-by: Marian Pritsak <[email protected]>

    Signed-off-by: Marian Pritsak <[email protected]>
    Co-authored-by: Mukesh Moopath Velayudhan <[email protected]>
    Co-authored-by: Chris Sommers <[email protected]>
    Co-authored-by: Chris Sommers <[email protected]>
    Co-authored-by: Marian Pritsak <[email protected]>

commit 8694184
Author: KrisNey-MSFT <[email protected]>
Date:   Mon Sep 12 16:25:46 2022 -0700

    Update program-scale-testing-requirements-draft.md

    Update Scale #'s per Keysight/MSFT call; document is a version which needs an update.

commit 2ce121e
Author: Chris Sommers <[email protected]>
Date:   Sun Sep 11 13:37:40 2022 -0700

    Fix ipv6 packet noise (#211)

    * Ensure ipv6 disabled on veth's prior to PTF tests, fix #205.

    * CHange docker registrey for ixia-c to Google cloud (was Dockerhub). No functional change but new b uilds will pull new image into workspaces.

    * Move ipv6 disable code to a separate shell script. Call it after deploy-ixiac target.

    Co-authored-by: Chris Sommers <[email protected]>

commit e31982c
Author: Chris Sommers <[email protected]>
Date:   Sun Sep 11 13:36:47 2022 -0700

    Fix docker & Makefile perms (#202)

    * Incremental work on docker permissions fixes.

    * More progress on docker and make permissions issues.

    * Trial remove -u root from CI file.

    * Makefile and CI file perms

    * Fix CI docker flags

    * Final purge of obs sudo commands to fix perms.

    * Test for veth's before deleting.

    Co-authored-by: Chris Sommers <[email protected]>

commit 32332b5
Merge: 9f62724 6d1c50a
Author: Michael Miele <[email protected]>
Date:   Wed Sep 7 17:46:27 2022 -0700

    Merge branch 'Azure:main' into main

commit 9f62724
Merge: 9b51bb7 e5e461a
Author: Michael Miele <[email protected]>
Date:   Thu Aug 25 09:11:30 2022 -0700

    Merge branch 'Azure:main' into main

commit 9b51bb7
Merge: 54eca5a 3c15d95
Author: Michael Miele <[email protected]>
Date:   Mon Jul 18 18:40:31 2022 -0700

    Merge branch 'Azure:main' into main

commit 54eca5a
Merge: 30c65ab 7b5ce5e
Author: Michael Miele <[email protected]>
Date:   Tue Jun 28 12:10:45 2022 -0700

    Merge branch 'Azure:main' into main

commit 30c65ab
Merge: 48ae39c c9612ff
Author: Michael Miele <[email protected]>
Date:   Mon Jun 20 10:27:44 2022 -0700

    Merge branch 'Azure:main' into main

commit 48ae39c
Merge: e4b3b64 49d9f2c
Author: Michael Miele <[email protected]>
Date:   Fri Jun 17 10:53:03 2022 -0700

    Merge branch 'Azure:main' into main

commit e4b3b64
Merge: 4120634 231212b
Author: Michael Miele <[email protected]>
Date:   Tue Jun 14 13:39:40 2022 -0700

    Merge branch 'Azure:main' into main

commit 4120634
Merge: b5c1700 a9ec96a
Author: Michael Miele <[email protected]>
Date:   Mon Jun 13 09:41:12 2022 -0700

    Merge branch 'Azure:main' into main

commit b5c1700
Merge: f541d44 2e28aef
Author: Michael Miele <[email protected]>
Date:   Mon Jun 13 09:31:01 2022 -0700

    Merge branch 'Azure:main' into main

commit f541d44
Merge: 1927911 8433203
Author: Michael Miele <[email protected]>
Date:   Wed Jun 8 13:40:39 2022 -0700

    Merge branch 'Azure:main' into main

commit 1927911
Merge: 569c32a d0807c8
Author: Michael Miele <[email protected]>
Date:   Tue May 31 13:49:13 2022 -0700

    Merge branch 'Azure:main' into main

commit 569c32a
Merge: d956391 e420737
Author: Michael Miele <[email protected]>
Date:   Fri May 20 16:25:33 2022 -0700

    Merge branch 'Azure:main' into main

commit d956391
Author: KrisNey-MSFT <[email protected]>
Date:   Tue May 10 16:34:33 2022 -0700

    Create sdn-packet-transforms-vm-to-vm.svg

    Edited Fast Path and Slow Path images

commit 18f88a4
Merge: b2c18a7 221c401
Author: Michael Miele <[email protected]>
Date:   Mon May 9 08:48:29 2022 -0700

    Merge branch 'Azure:main' into main

commit b2c18a7
Author: Michael Miele <[email protected]>
Date:   Mon May 9 08:47:53 2022 -0700

    sync-with-azure-dash (#8)

    * dash-holistic-view (#104)

    * draft document

    * Updated content and images

    * added image and updated content

    * fixed image

    * Update dash-architecture.md

    * Fixed image and caption

    * Update dash-architecture.md

    * added/reorganized images

    * Update dash-architecture.md

    * fixed image and content

    * Update dash-architecture.md

    * Update dash-hld-ecosystem.svg

    * Renamed file.

    * Update dash-hld-ecosystem.svg

    * Update dash-hld-ecosystem.svg

    * Update dash-architecture-view.md

    * Update dash-hld-ecosystem.svg

    * Update dash-architecture-view.md

    * Update dash-architecture-view.md

    * Update dash-architecture-view.md

    * Update dash-architecture-view.md

    * reorganized content

    * Update dash-architecture-view.md

    * Update dash-architecture-view.md

    * Fixed images and content based on feedback

    * move images, added captions, fixed content

    * Update dash-hld-project-ecosystem.svg

    * Update dash-architecture-view.md

    * Update dash-architecture-view.md

    * Update dash-architecture-view.md

    Fixed the "SONiC integration" section and linked to Prince's doc "dash-sonic-hld.md".

    * Update dash-architecture-view.md

    * fixed card opacity

    * Update dash-architecture-view.md

    * Update dash-architecture-view.md

    * Update dash-architecture-view.md

    * Update dash-architecture-view.md

    * Fixed image

    * fixed image

    * fixed image and related content

    * Update dash-architecture-view.md

    * Update dash-architecture-view.md

    * Update dash-architecture-view.md (#3)

    Merged in the PR: mmiele#2.

    * Renamed article and added content.

    * Update dash-architecture-view.md

    * Update dash-architecture-view.md

    * Update dash-architecture-view.md

    * Update dash-architecture-view.md

    * renamed file

    * Update dash-holistic-view.md

    * Update dash-holistic-view.md

    * Update dash-holistic-view.md

    * Update dash-holistic-view.md

    * Update dash-holistic-view.md

    * Update dash-holistic-view.md

    * fixed formating

    * Update dash-holistic-view.md

    * Update dash-holistic-view.md

    * Update dash-holistic-view.md

    * Fixed images

    * Fixed TOC

    * Update documentation/general/design/dash-holistic-view.md

    Co-authored-by: KrisNey-MSFT <[email protected]>

    * Update documentation/general/design/dash-holistic-view.md

    Co-authored-by: KrisNey-MSFT <[email protected]>

    * Apply suggestions from code review

    Co-authored-by: KrisNey-MSFT <[email protected]>

    * Apply suggestions from code review

    Co-authored-by: KrisNey-MSFT <[email protected]>

    * Updated content and added note

    * Fixed content

    * fixed metadata

    * Created .gitignore and removed bkp files

    * Fixed content based on feedback.

    * Fixed content based on feedback. Added links and special notes.  Fixed image.

    * Fixed diagrams: using gNMI container instead of DASH container.

    * Fixed title and typos

    * Added reference links

    * Update documentation/general/design/dash-holistic-view.md

    Change committed.

    Co-authored-by: KrisNey-MSFT <[email protected]>

    * Update dash-high-level-smart-switch.svg

    Changed "DASH container" name to "gNMI container".

    * Fixed image and moved `.gitignore` to the main folder.

    * Apply suggestions from code review

    Committed Kristina's suggestions.

    Co-authored-by: KrisNey-MSFT <[email protected]>

    * Update dash-holistic-view.md

    Renamed the section API to "SAI headers and behavioral model". Added links to the related README files.

    * Removed old dash-high-level-design.md

    deleted dash-high-level-design.md
    renamed dash-holistic-view.md to dash-high-level-design.md

    * Added the list of words to generate the "word cloud".

    * Update README.md

    Reversed the link order and fixed descriptions.

    Co-authored-by: KrisNey-MSFT <[email protected]>

    * Update dash-high-level-design.md

    * Update dash-high-level-design.md

    * Update dash-hld-project-ecosystem.svg

    * Update dash-high-level-design.md

    Co-authored-by: KrisNey-MSFT <[email protected]>

* Update vnet-to-vnet-service.md

Updated metadata.

* Update vnet-to-vnet-service.md

Update date

* Update vnet-to-vnet-service.md

Changed date

* Update vnet-to-vnet-service.md

Fixed date

* Update vnet-to-vnet-service.md

Updated

* Update vnet-to-vnet-service.md

Fixed date

* Create dash-sonic-hld.md

Sync with main

* Create program-scale-testing-requirements-draft.md

Sync with main

* Create AMD-Pensando_HA_Proposal.md

Sync with main

* Update vnet-to-vnet-service.md

Update

* Delete dash-sonic-hld.md

Reorganized general folder.

* Delete program-scale-testing-requirements-draft.md

Reorganized general folder.

* Update README.md

Removed the section "Organization of Design & Requirements Documents" because it is obsolete.

* Delete AMD-Pensando_HA_Proposal.md

Removed design folder.

* Fixed broken links

* Fixed links and removed obsolete one.

* Removed obsolete links.

* Update README.md

Removed obsolete link.

* Update README.md

Removed obsolete links.

* Removed obsolete links

Co-authored-by: KrisNey-MSFT <[email protected]>
  • Loading branch information
mmiele and KrisNey-MSFT authored Sep 20, 2022
1 parent d003f4e commit 04c06ff
Show file tree
Hide file tree
Showing 161 changed files with 989 additions and 1,255 deletions.
58 changes: 20 additions & 38 deletions documentation/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[[ << Back to DASH top-level README ](../README.md)]
# DASH Documentation

Documentation comprises system descriptions, High-level design (HLD) documents and detailed compliance requirements. These are contained in the [DASH/documentation](./) directory and subdirectories.
Expand All @@ -8,50 +7,33 @@ The testing framework, methodology, documentation and testing artifacts are stor
See also DASH [FAQ](https://github.com/Azure/DASH/wiki/FAQ) and [Glossary](https://github.com/Azure/DASH/wiki/Glossary).

# Contents

## Baseline Specifications and Requirements

All DASH devices shall conform to the following design specifications and compliance requirements:

| Topic | Links to Folders |
| ------- | ---------|
| General Architecture and Requirements| [Parent Folder](general/README.md) \| [ Design](general/design/README.md) \| [Compliance Requirements](general/requirements/README.md)|
| Data plane | [Parent Folder](dataplane/README.md) \| [ Design](dataplane/design/README.md) \| [Compliance Requirements](dataplane/requirements/README.md)|
| High-Availability (HA) | [Parent Folder](high-avail/README.md) \| [ Design](high-avail/design/README.md) \| [Compliance Requirements](high-avail/requirements/README.md)|
| gNMI Northbound API | [Parent Folder](gnmi/README.md) \| [ Design](gnmi/design/README.md) \| [Compliance Requirements](gnmi/requirements/README.md)|
| SAI Southbound API | [Parent Folder](sai/README.md) \| [ Design](sai/design/README.md) \| [Compliance Requirements](sai/requirements/README.md)|
| Topic | Documents |
| ------------------------------------- | --------------------------------------------|
| General Architecture and Requirements | [DASH general](./general/README.md)| |
| Data plane | [Data plane](./dataplane/README.md) |
| High-Availability (HA) | [High-Availability](./high-avail/README.md) |
| gNMI Northbound API | [gNMI Northbound API](./gnmi/README.md) |
| SAI Southbound API | [SAI Southbound API](./sai/README.md) |

## Service Specifications and Requirements

DASH devices may implement one or more of the following services.

They shall conform to each service's design specifications and compliance requirements.
| Topic | Links to Folders |
| ------- | ---------|
| Load Balancer Service | [Parent Folder](load-bal-service/README.md) \| [ Design](load-bal-service/design/README.md) \| [Compliance Requirements](load-bal-service/requirements/README.md)|
| VNET-to-VNET Service | [Parent Folder](vnet2vnet-service/README.md) \| [ Design](vnet2vnet-service/design/README.md) \| [Compliance Requirements](vnet2vnet-service/requirements/README.md)|
| Service Tunnel & Private Link Service | [Parent Folder](stpl-service/README.md) \| [ Design](stpl-service/design/README.md) \| [Compliance Requirements](stpl-service/requirements/README.md)|
| VNET Peering Service | [Parent Folder](vnet-peering-service/README.md) \| [ Design](vnet-peering-service/design/README.md) \| [Compliance Requirements](vnet-peering-service/requirements/README.md)|
| Express Route (ER) Service | [Parent Folder](express-route-service/README.md) \| [ Design](express-route-service/design/README.md) \| [Compliance Requirements](express-route-service/requirements/README.md)|
| Encryption Gateway Service | [Parent Folder](encrypt-gw-service/README.md) \| [ Design](encrypt-gw-service/design/README.md) \| [Compliance Requirements](encrypt-gw-service/requirements/README.md)|


# Organization of Design & Requirements Documents
Documentation consists of separate, but related *System Descriptions* (HLDs, architecture, theory of operations, etc.) and *Compliance Requirements* (hard specifications, typically numerical but also behavioral). These two types of documents are deliberately kept separated, see [Relationships and Flow of Documents](#relationships-and-flow-of-documents).

Documentation is organized into folders as follows. Each feature or topic has all the high-level specs and the compliance requirements in the same parent folder, e.g. General, High-Availability, etc., making it easier to access related information about one topic. As the complexity grows, this helps keep things organized according to "functional topic."
```
topic1
design
topic1 High-level Descriptions and architecture
requirements
topic1 compliance Requirements
topic2
design
topic2 High-level Descriptions
requirements
topic2 compliance Requirements
etc
...
```

| Topic | Documents |
| --------------------------------------| ------------------------------------------------------------------|
| Load Balancer Service | [Load Balancer Service](./load-bal-service/README.md) |
| VNET-to-VNET Service | [VNET-to-VNET Service](./vnet2vnet-service/README.md) |
| Service Tunnel & Private Link Service | [Service Tunnel & Private Link Service](./stpl-service/README.md) |
| VNET Peering Service | [VNET Peering Service ](./vnet-peering-service/README.md) |
| Express Route (ER) Service | [Express Route (ER) Service](./express-route-service/README.md) |
| Encryption Gateway Service | [Encryption Gateway Service](./encrypt-gw-service/README.md) |

# Relationships and Flow of Documents
The diagram below shows how High-Level Descriptions beget Compliance requirements, compliance requirements beget test cases, and test cases are executed by test scripts to produce Test Results.
Expand Down
20 changes: 13 additions & 7 deletions documentation/dataplane/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
[ [ << Back to DASH top-level Documents](../README.md#contents) ]

# DASH Data plane Documents

This folder contains DASH data plane design and requirements documents.

# Contents
## Design

| Document | Description |
| ------------------------------------------------------ | ------------------------------------------ |
|[dash-update-timing.md](dash-update-timing.md) |Routing, ACL, Mapping Updates (WIP) |
|[dash-config-schema-json.md](dash-config-schema-json.md) |Configuration schema example |



## Requirements

| Folder | Description |
| ------------------------------------------------------ | -------------------------------------------- |
| [design](design/README.md) | DASH Data plane design & architecture documents |
| [requirements](requirements/README.md) | DASH Data plane requirements documents |
| Document | Description |
| ------------------------------------------------------ | ------------------------------------------ |
13 changes: 0 additions & 13 deletions documentation/dataplane/design/README.md

This file was deleted.

12 changes: 0 additions & 12 deletions documentation/dataplane/requirements/README.md

This file was deleted.

16 changes: 10 additions & 6 deletions documentation/encrypt-gw-service/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
[ [ << Back to DASH top-level Documents](../README.md#contents) ]
# DASH Encryption Gateway Service Documents

This folder contains DASH Encryption Gateway Service design and requirements documents.

# Contents
## Design

| Folder | Description |
| ------------------------------------------------------ | -------------------------------------------- |
| [design](design/README.md) | DASH Encryption Gateway Service design & architecture documents |
| [requirements](requirements/README.md) | DASH Encryption Gateway Service requirements documents |
| Document | Description |
| ------------------------------------------------------ | ------------------------------------------ |


## Requirements

| Document | Description |
| ------------------------------------------------------ | ------------------------------------------ |
10 changes: 0 additions & 10 deletions documentation/encrypt-gw-service/design/README.md

This file was deleted.

10 changes: 0 additions & 10 deletions documentation/encrypt-gw-service/requirements/README.md

This file was deleted.

16 changes: 10 additions & 6 deletions documentation/express-route-service/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
[ [ << Back to DASH top-level Documents](../README.md#contents) ]
# DASH Express Route Gateway Service Documents

This folder contains DASH Express Route Gateway Service design and requirements documents.

# Contents
## Design

| Folder | Description |
| ------------------------------------------------------ | -------------------------------------------- |
| [design](design/README.md) | DASH Express Route Gateway Service design & architecture documents |
| [requirements](requirements/README.md) | DASH Express Route Gateway Service requirements documents |
| Document | Description |
| ------------------------------------------------------ | ------------------------------------------ |


## Requirements

| Document | Description |
| ------------------------------------------------------ | ------------------------------------------ |
10 changes: 0 additions & 10 deletions documentation/express-route-service/design/README.md

This file was deleted.

10 changes: 0 additions & 10 deletions documentation/express-route-service/requirements/README.md

This file was deleted.

27 changes: 19 additions & 8 deletions documentation/general/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,23 @@
[ [ << Back to DASH top-level Documents](../README.md#contents) ]

# DASH General Documents

This folder contains DASH "General" design and requirements documents.
This folder contains DASH general design and requirements documents.

## Design

| Document | Description |
| ------------------------------------------------------------------------- | -------------------------------------------------|
| [dash-high-level-design.md](dash-high-level-design.md) | DASH High-Level Architecture and Design |
| [dash-sonic-hld.md](dash-sonic-hld.md) | DASH APIs, orch agent, config and APP DB Schemas |
| [sdn-features-packet-transforms.md](sdn-features-packet-transforms.md) | DASH VNET-to-VNET HLD and Packet Transforms |
| [sdn-pipeline-basic-elements.md](sdn-pipeline-basic-elements.md) | Pipeline basics such as path direction and flow |
| [dash-handling-fragmented-packets.md](dash-handling-fragmented-packets.md)| Handling of packet fragments |
|||



# Contents
## Requirements

| Folder | Description |
| ------------------------------------------------------ | -------------------------------------------- |
| [design](design/README.md) | DASH General design & architecture documents |
| [requirements](requirements/README.md) | DASH General requirements documents |
| Document | Description |
| ---------------------------------------------------------------------------------- | ------------------------------------------ |
| [dash-general-compliance-requirements.md](dash-general-compliance-requirements.md) | DASH General Compliance Requirements |
| [program-scale-testing-requirements-draft.md](program-scale-testing-requirements-draft.md) | DASH scale and performance requirements |
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
[ [ << Back to parent directory](../README.md) ]

[ [ << Back to DASH top-level Documents](../../README.md#contents) ]

# DASH General Compliance Requirements
# DASH Versioning and Configuration Management

## DASH Versioning and Configuration Management

>**TODO** Determine a versioning system for each category as well as the overall configuration of a "release."
# Continuous Integration and Test
## Continuous Integration and Test
Continuous integration verifies the correctness of each committed configuration. Workflows can be triggered manually, or automatically (by commits). Success/failure can be criteria for accepting pull requests.

**TODO** Define objectives and implement automation (Git Actions). The follow non-exhaustive list is just an example of what can be done:
Expand All @@ -19,6 +16,6 @@ Continuous integration verifies the correctness of each committed configuration.
* Execute DASH software data planes via P4 behavioral models: run test suites which configure the software Device under Test (DUT) and send traffic to/from the data plane with software traffic testers. See [DASH Testing Using P4 Simulators and SAI Thrift](../test/docs/dash-test-workflow-p4-saithrift.md) for an example workflow.


# Reference Architectures
## Reference Architectures
Reference architectures for test scenarios are described in [test/docs/dash-test-ref-arch.md](../../../test/docs/dash-test-ref-arch.md)

Loading

0 comments on commit 04c06ff

Please sign in to comment.