Merge pull request #116 from NetApp/ckeith-update-readme

Added an architecture image to the README.md file.

Author: kcantrel

Monitoring/monitor-ontap-services/README.md

@@ -23,6 +23,16 @@ Here is an itemized list of the services that this program can monitor:
 - If a volume is over a certain percentage full. User can set two thresholds (Warning and Critical).
 - If any quotas are over a certain percentage full. User can follow both soft and hard limits.
 
+## Architecture
+The program is designed to be run as a Lambda function. It is triggered by an EventBridge rule that is set to run
+on a regular basis. The program will then use the ONTAP APIs to obtain the required information to determine if
+any of the conditions that are being monitored have been met. If they have, then the program will send an SNS message
+to the specified SNS topic. The program will also send a syslog message to a syslog server if the syslogIP parameter
+is set. The program will store the event information in an S3 bucket so that it can be compared against it before sending
+a second message for the same event. The configuration files is also kept in the S3 bucket for easy access.
+
+![Architecture](images/Monitoring_Ontap_Services_Architecture.png)
+
 ## Preparation
 There are a few things you need to do to properly deploy this script.
 
@@ -279,4 +289,4 @@ You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http:/
 
 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" basis, without WARRANTIES or conditions of any kind, either express or implied.
 
-See the License for the specific language governing permissions and limitations under the License.
+See the License for the specific language governing permissions and limitations under the License.