Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for the Software lifecycle #36

Merged
merged 2 commits into from
Nov 29, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ If you are on Nautobot >= 1.1.0 and have the RQ worker continuing on, also resta
sudo systemctl restart nautobot-rq-worker
```

## Documentation
- [Software lifecycle](./docs/software_lifecycle.md)

## Usage

### Adding Information into the Plugin
Expand Down Expand Up @@ -171,4 +174,41 @@ You can view the details of a contract along with the primary and escalation con

You can view the details of a provider, along with a listing of the service contracts associated to the provider. Contracts that are expired will display in red.

![](docs/images/lcm_contract_provider_detail.png)
![](docs/images/lcm_contract_provider_detail.png)

### Software: Software Life Cycle Management List View

You can view the list of Software versions as well as filter the table.

![](docs/images/lcm_software_list_view.png)


### Software: Software Life Cycle Detail View

You can also click a Software version and see the detail view. This view provides link to the list of devices and inventory items that are associated with this software object.

![](docs/images/lcm_software_detail_view.png)

### Software: Validated Software Life Cycle Management List View

You can view the list of Validated Software versions as well as filter the table.

![](docs/images/lcm_validated_software_list_view.png)

### Software: Validated Software Life Cycle Detail View

You can also click a Validated Software version and see the detail view. This view provides view of the device and inventory item attributes this validated software applies to.

![](docs/images/lcm_validated_software_detail_view.png)

### Software: Device View

You can also view the associated Software and Validated Software versions from the device. If the Software assigned to the device matches Validated Software for this device, the Software will be displayed in green. If it's invalid it will be displayed in red.

**Valid software:**

![](docs/images/lcm_software_device_view_valid.png)

**Invalid software:**

![](docs/images/lcm_software_device_view_invalid.png)
4 changes: 2 additions & 2 deletions docs/add_information.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ To add information via the REST API, please look at the Swagger API docs for the

### Hardware Lifecycle

When running Nautobot 1.1.0 or later, there is a separate menu added named `Device Lifecycle`. This will be seen on the top menu bar. From here you will find the typical navigation for the addition of items. For example, to add a Hardware Notice for end of life, select `Device LifeCycle` -> Plus sign next to `Hardware Notices`. This will bring up the new Hardware notice page. In this page, fill out the appropriate information from the drop down menus to create the hardware notice.
When running Nautobot 1.1.0 or later, there is a separate menu added named `Device Lifecycle`. This will be seen on the top menu bar. From here you will find the typical navigation for the addition of items. For example, to add a Hardware Notice for end of life, select `Device Lifecycle` -> Plus sign next to `Hardware Notices`. This will bring up the new Hardware notice page. In this page, fill out the appropriate information from the drop down menus to create the hardware notice.

> In order for a hardware notice to be created, there must be either an existing Device Type or Inventory Item that can be found in the database. Without these data points, the data cannot be added, as a relationship is built to the particular items.

### Software
### Software Lifecycle

Software follows the same methodology. First you add Software that is applicable for a particular platform. Then fill in the required fields of Version and add the corresponding relationships.

Expand Down
Binary file added docs/images/lcm_software_detail_view.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/lcm_software_device_view_valid.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/lcm_software_list_view.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/lcm_software_software_add.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.