Skip to content

Commit 6d11ca0

Browse files
authored
fixes
* update readme * added license
2 parents 80fcdd7 + 67a14be commit 6d11ca0

File tree

4 files changed

+159
-6
lines changed

4 files changed

+159
-6
lines changed

CODE_OF_CONDUCT.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as maintainers of this Cisco Sample Code pledge to making participation with our project a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Showing empathy towards other people
15+
16+
Examples of unacceptable behavior include:
17+
18+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
19+
* Trolling, insulting/derogatory comments, and personal or political attacks
20+
* Public or private harassment
21+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
22+
* Other conduct which could reasonably be considered inappropriate in a professional setting
23+
24+
## Our Responsibilities
25+
26+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
27+
28+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other interactions with this project that are not aligned to this Code of Conduct, or to ban temporarily or permanently any person for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
29+
30+
## Scope
31+
32+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project. Examples of representing a project include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
33+
34+
## Enforcement
35+
36+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Cisco SE GitHub team at ciscose-github@cisco.com. The team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
37+
38+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project or Cisco SE Leadership.
39+
40+
## Attribution
41+
42+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
43+
44+
[homepage]: http://contributor-covenant.org
45+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Cisco Sample Code
2+
3+
This project, and the code contained herein, is provided for example or demonstration purposes by Cisco for use by our partners and customers in working with Cisco's products and services. While Cisco's customers and partners are free to use this code according to the terms of the [LICENSE](./LICENSE) associated with this project, this is not an *Open Source* project in as much as we are not seeking to build a community around the project and its capabilities.
4+
5+
We do desire to provide functional and high-quality examples and demonstrations. If you should discover some bug, issue, or opportunity for enhancement with the sample code contained in this project, please notify us by creating a new **Issue**.

LICENSE.txt

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
CISCO SAMPLE CODE LICENSE
2+
Version 1.1
3+
Copyright (c) 2020 Cisco and/or its affiliates
4+
5+
These terms govern this Cisco Systems, Inc. ("Cisco"), example or demo
6+
source code and its associated documentation (together, the "Sample
7+
Code"). By downloading, copying, modifying, compiling, or redistributing
8+
the Sample Code, you accept and agree to be bound by the following terms
9+
and conditions (the "License"). If you are accepting the License on
10+
behalf of an entity, you represent that you have the authority to do so
11+
(either you or the entity, "you"). Sample Code is not supported by Cisco
12+
TAC and is not tested for quality or performance. This is your only
13+
license to the Sample Code and all rights not expressly granted are
14+
reserved.
15+
16+
1. LICENSE GRANT: Subject to the terms and conditions of this License,
17+
Cisco hereby grants to you a perpetual, worldwide, non-exclusive, non-
18+
transferable, non-sublicensable, royalty-free license to copy and
19+
modify the Sample Code in source code form, and compile and
20+
redistribute the Sample Code in binary/object code or other executable
21+
forms, in whole or in part, solely for use with Cisco products and
22+
services. For interpreted languages like Java and Python, the
23+
executable form of the software may include source code and
24+
compilation is not required.
25+
26+
2. CONDITIONS: You shall not use the Sample Code independent of, or to
27+
replicate or compete with, a Cisco product or service. Cisco products
28+
and services are licensed under their own separate terms and you shall
29+
not use the Sample Code in any way that violates or is inconsistent
30+
with those terms (for more information, please visit:
31+
www.cisco.com/go/terms).
32+
33+
3. OWNERSHIP: Cisco retains sole and exclusive ownership of the Sample
34+
Code, including all intellectual property rights therein, except with
35+
respect to any third-party material that may be used in or by the
36+
Sample Code. Any such third-party material is licensed under its own
37+
separate terms (such as an open source license) and all use must be in
38+
full accordance with the applicable license. This License does not
39+
grant you permission to use any trade names, trademarks, service
40+
marks, or product names of Cisco. If you provide any feedback to Cisco
41+
regarding the Sample Code, you agree that Cisco, its partners, and its
42+
customers shall be free to use and incorporate such feedback into the
43+
Sample Code, and Cisco products and services, for any purpose, and
44+
without restriction, payment, or additional consideration of any kind.
45+
If you initiate or participate in any litigation against Cisco, its
46+
partners, or its customers (including cross-claims and counter-claims)
47+
alleging that the Sample Code and/or its use infringe any patent,
48+
copyright, or other intellectual property right, then all rights
49+
granted to you under this License shall terminate immediately without
50+
notice.
51+
52+
4. LIMITATION OF LIABILITY: CISCO SHALL HAVE NO LIABILITY IN CONNECTION
53+
WITH OR RELATING TO THIS LICENSE OR USE OF THE SAMPLE CODE, FOR
54+
DAMAGES OF ANY KIND, INCLUDING BUT NOT LIMITED TO DIRECT, INCIDENTAL,
55+
AND CONSEQUENTIAL DAMAGES, OR FOR ANY LOSS OF USE, DATA, INFORMATION,
56+
PROFITS, BUSINESS, OR GOODWILL, HOWEVER CAUSED, EVEN IF ADVISED OF THE
57+
POSSIBILITY OF SUCH DAMAGES.
58+
59+
5. DISCLAIMER OF WARRANTY: SAMPLE CODE IS INTENDED FOR EXAMPLE PURPOSES
60+
ONLY AND IS PROVIDED BY CISCO "AS IS" WITH ALL FAULTS AND WITHOUT
61+
WARRANTY OR SUPPORT OF ANY KIND. TO THE MAXIMUM EXTENT PERMITTED BY
62+
LAW, ALL EXPRESS AND IMPLIED CONDITIONS, REPRESENTATIONS, AND
63+
WARRANTIES INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTY OR
64+
CONDITION OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-
65+
INFRINGEMENT, SATISFACTORY QUALITY, NON-INTERFERENCE, AND ACCURACY,
66+
ARE HEREBY EXCLUDED AND EXPRESSLY DISCLAIMED BY CISCO. CISCO DOES NOT
67+
WARRANT THAT THE SAMPLE CODE IS SUITABLE FOR PRODUCTION OR COMMERCIAL
68+
USE, WILL OPERATE PROPERLY, IS ACCURATE OR COMPLETE, OR IS WITHOUT
69+
ERROR OR DEFECT.
70+
71+
6. GENERAL: This License shall be governed by and interpreted in
72+
accordance with the laws of the State of California, excluding its
73+
conflict of laws provisions. You agree to comply with all applicable
74+
United States export laws, rules, and regulations. If any provision of
75+
this License is judged illegal, invalid, or otherwise unenforceable,
76+
that provision shall be severed and the rest of the License shall
77+
remain in full force and effect. No failure by Cisco to enforce any of
78+
its rights related to the Sample Code or to a breach of this License
79+
in a particular situation will act as a waiver of such rights. In the
80+
event of any inconsistencies with any other terms, this License shall
81+
take precedence.

README.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,32 @@ _(aws s3)_
4646
- ```git clone https://github.com/robertcsapo/cisco-dnac-network-devices-cfg-backup-s3```
4747

4848
* Setup
49-
- Edit the ```docker-compose.yaml``` for your personal settings.
49+
- Edit the ```docker-compose.yaml``` for your Environments settings/credentials.
5050
_(Default is AWS S3 Storage)_
51+
```
52+
version: '3'
53+
services:
54+
collector:
55+
image: robertcsapo/cisco-dnac-network-devices-cfg-backup-s3
56+
environment:
57+
- DNAC_HOST=dnac.example.tld
58+
- DNAC_USER=exampleUsername
59+
- DNAC_PASS=examplePassword
60+
- DNAC_SSL_VERIFY=False
61+
- STORAGE=AWS
62+
- S3BUCKET=cisco-dnac-network-devices-cfg-backup-s3
63+
- AWS_ACCESS_KEY=XXXXACCESS_KEY
64+
- AWS_SECRET_KEY=YYYYSECRET_KEY
65+
network_mode: bridge
66+
```
5167
- If you want to use other Storage providers.
5268
Edit ```docker-compose-<provider>.yaml``` file instead.
69+
```
70+
docker-compose-aws.yaml
71+
docker-compose-do.yaml
72+
docker-compose-gcp.yaml
73+
docker-compose-minio.yaml
74+
```
5375

5476
* Run service
5577
- Default
@@ -99,19 +121,19 @@ Use this settings if not using Environment or want to override
99121
--version show program's version number and exit
100122
```
101123
* Example
102-
- ```docker run robertcsapo/cisco-dnac-network-devices-cfg-backup-s3 --dnac DNAC_HOST DNAC_USER DNAC_PASS --aws S3BUCKET AWS_ACCESS_KEY AWS_SECRET_KEY```
124+
- ```docker run robertcsapo/cisco-dnac-network-devices-cfg-backup-s3 --dnac dnac.example.tld exampleUsername examplePassword --aws cisco-dnac-network-devices-cfg-backup-s3 XXXXACCESS_KEY YYYYSECRET_KEY```
103125

104-
- Docker with Environment
126+
- Docker with Environments settings/credentials
105127
* ```docker run robertcsapo/cisco-dnac-network-devices-cfg-backup-s3 -e DNAC_HOST <value> -e DNAC_USER <value> -e DNAC_PASS <value> -e S3BUCKET <value> -e AWS_ACCESS_KEY <value> -e AWS_SECRET_KEY <value> -e STORAGE=AWS ```
106128
_(Change STORAGE to another provider if needed)_
107129
- OS Environments
108130
- ```DNAC_HOST=dnac.example.tld```
109-
- ```DNAC_USER=username```
110-
- ```DNAC_PASS=password```
131+
- ```DNAC_USER=exampleUsername```
132+
- ```DNAC_PASS=examplePassword```
111133
- ```STORAGE=AWS (or GCP, DO, MINIO)```
112134
- ```S3BUCKET=bucket```
113135
- ```AWS_ACCESS_KEY=key```
114-
- ```AWS_SECRET_KEY=key```
136+
- ```AWS_SECRET_KEY=key```
115137
_(check docker-compose-<provider>.yaml for OS Environments)_
116138

117139

0 commit comments

Comments
 (0)