├── .gitignore ├── scripts └── cidataiso.sh ├── README.md ├── devenv-cloud-config.yaml └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *.iso 2 | -------------------------------------------------------------------------------- /scripts/cidataiso.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh -l 2 | 3 | # 4 | # SPDX-License-Identifier: Apache-2.0 5 | # 6 | 7 | usage() { 8 | echo "Usage: cidataiso.sh -u " 9 | echo 10 | echo " Creates a cloud init ISO" 11 | echo 12 | echo " Flags:" 13 | echo " -u - the cloud-config user-data file to include in the ISO" 14 | echo " -h - Print this message" 15 | } 16 | 17 | error_exit() { 18 | echo "${1:-"Unknown Error"}" 1>&2 19 | exit 1 20 | } 21 | 22 | while getopts "hu:" opt; do 23 | case "$opt" in 24 | h) 25 | usage 26 | exit 0 27 | ;; 28 | u) 29 | config=${OPTARG} 30 | ;; 31 | *) 32 | usage 33 | exit 1 34 | ;; 35 | esac 36 | done 37 | shift $((OPTIND-1)) 38 | 39 | if [ ! -f "$config" ]; then 40 | usage 41 | exit 1 42 | fi 43 | 44 | isoname=config.iso 45 | 46 | prefix=$(basename "$0") 47 | tempdir=$(mktemp -d -t "$prefix.XXXXXXXX") || error_exit "Error creating temporary directory" 48 | 49 | if [ -n "$DEBUG" ]; then 50 | echo "config = $config" 51 | echo "isoname = $isoname" 52 | echo "tempdir = $tempdir" 53 | fi 54 | 55 | mkdir -p "$tempdir/cidata" 56 | cp "$config" "$tempdir/cidata/user-data" 57 | touch "$tempdir/cidata/meta-data" 58 | 59 | if command -v hdiutil > /dev/null; then 60 | hdiutil makehybrid -o "$isoname" -hfs -joliet -iso -default-volume-name cidata "$tempdir/cidata" 61 | elif command -v genisoimage > /dev/null; then 62 | genisoimage -output "$isoname" -volid cidata -joliet -rock "$tempdir/cidata/user-data" "$tempdir/cidata/meta-data" 63 | else 64 | error_exit "Cannot find hdiutil or genisoimage" 65 | fi 66 | 67 | rm -Rf "$tempdir" 68 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # fabric-cloud-init 2 | 3 | Experimental cloud config to set up a Fabric development environment which is intended to work on both amd64 and arm64 architectures. 4 | 5 | **Important:** Due to the lack of arm64 based Fabric docker images, the only option for running smart contracts on arm64 is to use the nano test network and the chaincode as a service (CCaaS) builder. 6 | 7 | ## Usage 8 | 9 | ```shell 10 | multipass launch \ 11 | --name fabric-dev \ 12 | --disk 80G \ 13 | --cpus 8 \ 14 | --mem 8G \ 15 | --cloud-init devenv-cloud-config.yaml 16 | ``` 17 | 18 | And then... 19 | 20 | ```shell 21 | multipass shell fabric-dev 22 | ``` 23 | 24 | And then... 25 | 26 | ```shell 27 | setup-fabric 28 | ``` 29 | 30 | No and then... 31 | 32 | Everything should be ready to start developing and testing Fabric chaincode! 33 | 34 | ## Running chaincode as a service 35 | 36 | First, change to the nano test network directory. 37 | 38 | ```shell 39 | cd ~/fabric-samples/test-network-nano-bash/ 40 | ``` 41 | 42 | Next, start the Fabric network. 43 | 44 | ```shell 45 | ./network.sh start 46 | ``` 47 | 48 | Open another terminal, and shell in to the `fabric-dev` VM again. 49 | 50 | ```shell 51 | multipass shell fabric-dev 52 | ``` 53 | 54 | Make sure you're in the nano test network directory. 55 | 56 | ```shell 57 | cd ~/fabric-samples/test-network-nano-bash/ 58 | ``` 59 | 60 | Set up the environment to run `peer` commands against `peer1`. 61 | 62 | ```shell 63 | . ./peer1admin.sh 64 | ``` 65 | 66 | Create a CCaaS package. 67 | 68 | ```shell 69 | pkgccaas -l devcc -a 127.0.0.1:9999 70 | ``` 71 | 72 | Install the CCaaS package. 73 | 74 | ```shell 75 | peer lifecycle chaincode install devcc.tgz 76 | ``` 77 | 78 | Export a PACKAGE_ID environment variable for use in the following commands. 79 | 80 | ```shell 81 | export PACKAGE_ID=$(peer lifecycle chaincode calculatepackageid devcc.tgz) && echo $PACKAGE_ID 82 | ``` 83 | 84 | Note: the PACKAGE_ID must match the chaincode code package identifier shown by the peer lifecycle chaincode install command. 85 | 86 | Approve the chaincode. 87 | 88 | ```shell 89 | peer lifecycle chaincode approveformyorg -o 127.0.0.1:6050 --channelID mychannel --name dev-contract --version 1 --package-id $PACKAGE_ID --sequence 1 --tls --cafile ${PWD}/crypto-config/ordererOrganizations/example.com/orderers/orderer.example.com/tls/ca.crt 90 | ``` 91 | 92 | Commit the chaincode. 93 | 94 | ```shell 95 | peer lifecycle chaincode commit -o 127.0.0.1:6050 --channelID mychannel --name dev-contract --version 1 --sequence 1 --tls --cafile "${PWD}"/crypto-config/ordererOrganizations/example.com/orderers/orderer.example.com/tls/ca.crt 96 | ``` 97 | 98 | Everything is configured but now you actually need to run some chaincode for Fabric to connect to! 99 | Open another new terminal, and shell in to the `fabric-dev` VM again. 100 | 101 | ```shell 102 | multipass shell fabric-dev 103 | ``` 104 | 105 | Change to the a suitable chaincode source directory, e.g. 106 | 107 | ```shell 108 | cd ~/fabric-samples/asset-transfer-basic/chaincode-go/ 109 | ``` 110 | 111 | Export a `CORE_CHAINCODE_ID_NAME` environment variable, which is required to run chaincode as a service. 112 | This is the same as the `PACKAGE_ID` in previous steps. 113 | [TODO: don't include the value here?] 114 | 115 | ```shell 116 | export CORE_CHAINCODE_ID_NAME=devcc:f357d81429a6a2fe63708d257e18e9c35dfe06c6b073c85b4baa65b0b4f159cb 117 | ``` 118 | 119 | Export a `CHAINCODE_SERVER_ADDRESS` environment variable, which is the address the chaincode will run at. 120 | 121 | ```shell 122 | export CHAINCODE_SERVER_ADDRESS=0.0.0.0:9999 123 | ``` 124 | 125 | Update the chaincode to the latest version of `fabric-contract-api-go`. 126 | [TODO: fix this!] 127 | 128 | ```shell 129 | go get -u github.com/hyperledger/fabric-contract-api-go 130 | go mod tidy 131 | ``` 132 | 133 | Start the chaincode! 134 | 135 | ```shell 136 | go run assetTransfer.go 137 | ``` 138 | 139 | To run transactions, switch back to the terminal you used to run the `peer` commands. 140 | 141 | For example, query the chaincode metadata. 142 | 143 | ```shell 144 | peer chaincode query -C mychannel -n dev-contract -c '{"Args":["org.hyperledger.fabric:GetMetadata"]}' 145 | ``` 146 | 147 | ## Work in progress 148 | 149 | Nothing to see here! 150 | 151 | Would a specific fabric user with ssh access be useful? (TBC) 152 | 153 | ```yaml 154 | users: 155 | - name: fabdev 156 | lock_passwd: false 157 | sudo: ['ALL=(ALL) NOPASSWD:ALL'] 158 | groups: sudo 159 | shell: /bin/bash 160 | 161 | chpasswd: 162 | expire: true 163 | users: 164 | - name: fabdev 165 | type: RANDOM 166 | 167 | runcmd: 168 | - sed -i -e '/^Port/s/^.*$/Port 4444/' /etc/ssh/sshd_config 169 | - sed -i -e '/^PermitRootLogin/s/^.*$/PermitRootLogin no/' /etc/ssh/sshd_config 170 | - sed -i -e '$aAllowUsers demo' /etc/ssh/sshd_config 171 | - restart ssh 172 | ``` 173 | 174 | Git clone or download source tarball? 175 | 176 | ```shell 177 | wget -O fabric.tar.gz https://github.com/hyperledger/fabric/archive/refs/tags/v2.4.6.tar.gz 178 | 179 | git clone --depth 1 --branch release-2.4 https://github.com/hyperledger/fabric.git 180 | ``` 181 | 182 | Cannot use `make release` because Fabric Makefile doesn't include arm in release platforms... 183 | 184 | ``` 185 | RELEASE_PLATFORMS = darwin-amd64 linux-amd64 windows-amd64 linux-arm64 186 | ``` 187 | 188 | What's up with Go? It keeps complaining that `warning: GOPATH set to GOROOT (/usr/local/go) has no effect` which doesn't appear to be true! At least I've not found another way to get the binaries installed in the right place yet! 189 | 190 | ``` 191 | GOMODCACHE=/usr/local/go/pkg/mod GOCACHE=/root/.cache/go-build 192 | ``` 193 | 194 | 195 | 196 | 197 | 198 | K8s.. 199 | 200 | kind create cluster 201 | 202 | kubectl cluster-info --context kind-kind 203 | 204 | export KUBECONFIG_PATH=$HOME/.kube/config 205 | 206 | ip addr show docker0 <- didn't work! 207 | 208 | docker exec kind-control-plane sh -c 'ip addr show eth0' 209 | 210 | docker network inspect kinds 211 | 212 | jq to extract Gateway? 213 | 214 | Find/replace CCADDR with the default gateway in the four peerX.sh scripts, e.g. 172.18.0.1 215 | 216 | ./network.sh start 217 | 218 | New terminal in nano test network dir... 219 | 220 | cd ~/fabric-samples/test-network-nano-bash/ 221 | 222 | . ./peer1admin.sh 223 | 224 | ``` 225 | curl -fsSL \ 226 | https://github.com/hyperledgendary/conga-nft-contract/releases/download/v0.1.3/conga-nft-contract-v0.1.3.tgz \ 227 | -o conga-nft.tgz 228 | ``` 229 | 230 | peer lifecycle chaincode install conga-nft.tgz 231 | 232 | export PACKAGE_ID=$(peer lifecycle chaincode calculatepackageid conga-nft.tgz) && echo $PACKAGE_ID 233 | 234 | peer lifecycle chaincode approveformyorg -o 127.0.0.1:6050 --channelID mychannel --name sample-contract --version 1 --package-id $PACKAGE_ID --sequence 1 --tls --cafile ${PWD}/crypto-config/ordererOrganizations/example.com/orderers/orderer.example.com/tls/ca.crt 235 | 236 | peer lifecycle chaincode commit -o 127.0.0.1:6050 --channelID mychannel --name sample-contract --version 1 --sequence 1 --tls --cafile "${PWD}"/crypto-config/ordererOrganizations/example.com/orderers/orderer.example.com/tls/ca.crt 237 | 238 | peer chaincode query -C mychannel -n sample-contract -c '{"Args":["org.hyperledger.fabric:GetMetadata"]}' 239 | 240 | 241 | 242 | 243 | 244 | 245 | 246 | 247 | https://docs.docker.com/network/network-tutorial-standalone/ 248 | 249 | https://gist.github.com/developer-guy/173347e71f92a61abbc017deb518b6cb 250 | 251 | 252 | kubectl run bash-shell --rm -i --tty --image ubuntu -- bash 253 | 254 | kubectl apply -f https://k8s.io/examples/application/shell-demo.yaml 255 | -------------------------------------------------------------------------------- /devenv-cloud-config.yaml: -------------------------------------------------------------------------------- 1 | #cloud-config 2 | 3 | groups: 4 | - docker 5 | 6 | system_info: 7 | default_user: 8 | groups: [docker] 9 | 10 | apt: 11 | sources: 12 | docker.list: 13 | source: deb https://download.docker.com/linux/ubuntu $RELEASE stable 14 | keyid: 9DC858229FC7DD38854AE2D88D81803C0EBFCD88 15 | kubernetes.list: 16 | source: deb https://apt.kubernetes.io/ kubernetes-xenial main 17 | keyid: 7F92E05B31093BEF5A3C2D38FEEA9169307EA071 18 | 19 | # prebuilt-mpr should have "just" but doesn't seem to include arm :( 20 | # prebuilt.list: 21 | # source: deb https://proget.makedeb.org prebuilt-mpr $RELEASE 22 | # key: | 23 | # -----BEGIN PGP PUBLIC KEY BLOCK----- 24 | # Version: BCPG C# v1.8.1.0 25 | 26 | # mQINBGJslcEBEACWT0Kphz3bmIO7s3BRW8Rw2m36YI0lDQmdkZy9F6Aa8+Ov9b6+ 27 | # 44hAvPYfm0fjOiGxq264v9Av5/26vcrDYsPKupaQs6EjT0NjcZ2A47KLpeJGzbzt 28 | # 74KP+YyKm/oqW8Md8jb8GBRq0dnFoLOOA6bvHzP7TzANAKFIEZQ0m4GO/AI6Y9ap 29 | # 09Q+gZramLl9OCoKRhnmC7QiJO9PSLLvBJOWk3pORpMU5GK5df2RYgpC6d0laFe4 30 | # KmmqcmuU7PgGAJ9C0Fy9i4WEEPdIrJ1Sg0PNnCloLGxFYg1he3gkF2GnTHAU05Ih 31 | # yc1anMv4MDh5m3+Em3laEnR16lMPPi/veLvdyGJ61f1I8cih391afvHloN2J3Z+j 32 | # 0sZN7BZthIWkoqhd6DnZ+XGwJoM3lAsPaH3uHsNtquWIqEOO0UBndIOmrcVd5QyY 33 | # 1tAJBQHl9XDRirIfsbFxESevANTkc6DCe7VPLADK/nTqwVrrruOZAIXrEwnoWTFj 34 | # xxl7lW+zswiVJWcpYIMQClCAgdq0g7bLs3UvPn4cUYYLTXRp+3LDps7hwmmoEYCD 35 | # bsp4exVPS9Whzu2/6ojR4pwJcXdvXsnPsqcQGwwd/pNaJrjC/BmWbQBZaBspfj2X 36 | # AtnhObFJkB49UWr+cFBIcoJAUEL16WyAf/o/1K8n1299Cc1QeUgBg1F41wARAQAB 37 | # tBNjb250YWN0QG1ha2VkZWIub3JniQIlBBMBAgAPApsDBYJibJXBBYkAAAAAAAoJ 38 | # EE/p8sQ9lCig3esQAIXM6ib4PJqKbAd5enhPBkAquZzLIsdaNg3f5dqan5BptIGM 39 | # 8EOS82Urlw7PACLlqf8lkM+0riU1SXGuEig+TFHHeYE9xYL9JguLnT+Iumfe/0YM 40 | # y/26VNadQJv581eJUnRfOBdhUFsCwksLE28qq8SKDq9a8n719TgPngTZNaD0zCNB 41 | # Tk90cwa7oRfUQza9IMn/7AvjvkpuwpsyZeSMj4RNL+1PaqgSgF1W94YWbXGO0e+g 42 | # fyp+r8WH0rYEUbl51FxGw5vXV9hGKe2Xbo40TAIv//l//8LeluA3P4nzPnr1pGaq 43 | # iqsIsVTfluC8OC0uEFTnsMCiyEUnP7LlCJc5dZeA+JfSuiwUI117cZ5TQr8uRY9L 44 | # zHiwKJkkrg2XNxwjQ20BZASd4HOHW8NcD/MULUL3d+pQ+lzbqcHLqT69YJdfVnPa 45 | # PEAsjHEauDbwgHyhy2pa2l43GcvecxlZTIXgKH+gGO+G2vC3vMFVcPLN0JWbHEkD 46 | # Tyiht2rMcIaEGXqzigc/S9czkOzsUuFdlWlBslBxJ6/yJYj5kvpSyGRJIe0dKZMp 47 | # yYDQQmO0+OuA75BUveDK9v9msA25NX8Ynus7tNh1LdlSnaJv6JYEIEhWDVBEkPmQ 48 | # TKGNsT2a5xrLry8pS3XJYThitIc8G7/ngzVOejsZ94G4OmYuCQxK97Hf/aHu 49 | # =Vi1D 50 | # -----END PGP PUBLIC KEY BLOCK----- 51 | 52 | package_update: true 53 | package_upgrade: true 54 | 55 | packages: 56 | - jq 57 | - curl 58 | - software-properties-common 59 | - apt-transport-https 60 | - ca-certificates 61 | - gnupg-agent 62 | - software-properties-common 63 | - docker-ce 64 | - docker-ce-cli 65 | - containerd.io 66 | - make 67 | - gcc 68 | - tzdata 69 | - kubectl 70 | 71 | write_files: 72 | - path: /etc/profile 73 | content: | 74 | export PATH=$PATH:$HOME/go/bin:/usr/local/go/bin 75 | append: true 76 | - path: /etc/nsswitch.conf 77 | content: | 78 | hosts: files dns 79 | - path: /usr/local/bin/pkgccaas 80 | permissions: '0755' 81 | content: | 82 | #!/usr/bin/env sh 83 | 84 | # TODO: 85 | # - download pkgccaas script from git instead of embedding it in yaml? 86 | # - same for pkgk8s, or combine the two? 87 | 88 | usage() { 89 | echo "Usage: pkgccaas -l -a

[-m ]" 90 | } 91 | 92 | error_exit() { 93 | echo "${1:-"Unknown Error"}" 1>&2 94 | exit 1 95 | } 96 | 97 | while getopts "hl:a:m:" opt; do 98 | case "$opt" in 99 | h) 100 | usage 101 | exit 0 102 | ;; 103 | l) 104 | label=${OPTARG} 105 | ;; 106 | m) 107 | metainf=${OPTARG} 108 | ;; 109 | a) 110 | address=${OPTARG} 111 | ;; 112 | *) 113 | usage 114 | exit 1 115 | ;; 116 | esac 117 | done 118 | shift $((OPTIND-1)) 119 | 120 | if [ -z "$label" ] || [ -z "$address" ]; then 121 | usage 122 | exit 1 123 | fi 124 | 125 | metadir=$(basename "$metainf") 126 | if [ -n "$metainf" ]; then 127 | if [ "META-INF" != "$metadir" ]; then 128 | error_exit "Invalid chaincode META-INF directory $metadir: directory name must be 'META-INF'" 129 | elif [ ! -d "$metainf" ]; then 130 | error_exit "Cannot find directory $metadir" 131 | fi 132 | fi 133 | 134 | prefix=$(basename "$0") 135 | tempdir=$(mktemp -d -t "$prefix.XXXXXXXX") || error_exit "Error creating temporary directory" 136 | 137 | if [ -n "$DEBUG" ]; then 138 | echo "label = $label" 139 | echo "address = $address" 140 | echo "tempdir = $tempdir" 141 | echo "metainf = $metainf" 142 | fi 143 | 144 | mkdir -p "$tempdir/src" 145 | cat > "$tempdir/src/connection.json" << CONNECTION-EOF 146 | { 147 | "address": "${address}", 148 | "dial_timeout": "10s", 149 | "tls_required": false 150 | } 151 | CONNECTION-EOF 152 | 153 | if [ -n "$metainf" ]; then 154 | cp -a "$metainf" "$tempdir/src/" 155 | fi 156 | 157 | mkdir -p "$tempdir/pkg" 158 | cat << METADATA-EOF > "$tempdir/pkg/metadata.json" 159 | { 160 | "type": "ccaas", 161 | "label": "$label" 162 | } 163 | METADATA-EOF 164 | 165 | tar -C "$tempdir/src" -czf "$tempdir/pkg/code.tar.gz" . 166 | 167 | tar -C "$tempdir/pkg" -czf "$label.tgz" metadata.json code.tar.gz 168 | 169 | rm -Rf "$tempdir" 170 | - path: /usr/local/bin/setup-fabric 171 | permissions: '0755' 172 | content: | 173 | #!/usr/bin/env sh 174 | 175 | # Hacky script to setup Fabric without needing to rely on published 176 | # binaries, since those don't exist for arm machines. 177 | # 178 | # TODO: 179 | # - download setup script from git instead of embedding it in yaml? 180 | # - add arguments for fabric version? 181 | # - make it less hacky?! 182 | 183 | mkdir -p "$HOME/go/src/github.com/hyperledger" 184 | git clone --depth 1 --branch release-2.4 https://github.com/hyperledger/fabric.git "$HOME/go/src/github.com/hyperledger/fabric" 185 | 186 | cd "$HOME/go/src/github.com/hyperledger/fabric" 187 | CGO_ENABLED=0 make orderer 188 | CGO_ENABLED=0 make tools 189 | CGO_ENABLED=0 make ccaasbuilder 190 | cd - 191 | 192 | mkdir -p "$HOME/go/bin" 193 | cp "$HOME/go/src/github.com/hyperledger/fabric/build/bin/"* "$HOME/go/bin" 194 | 195 | git clone --depth 1 --branch main https://github.com/hyperledger/fabric-samples.git "$HOME/fabric-samples" 196 | mkdir -p "$HOME/fabric-samples/config" 197 | cp "$HOME/go/src/github.com/hyperledger/fabric/sampleconfig/"*.yaml "$HOME/fabric-samples/config" 198 | 199 | mkdir -p "$HOME/fabric-builders" 200 | ln -s "$HOME/go/src/github.com/hyperledger/fabric/release/linux-arm64/builders/ccaas" "$HOME/fabric-builders/ccaas" 201 | 202 | mkdir -p "$HOME/fabric-builders/k8s/bin" 203 | wget -qO- https://github.com/hyperledger-labs/fabric-builder-k8s/releases/download/v0.8.0/fabric-builder-k8s-v0.8.0-$(go env GOOS)-$(go env GOARCH).tgz | tar -C "$HOME/fabric-builders/k8s/bin" -xzf - 204 | 205 | # TODO: just replace the external builders completely? 206 | yq e 'del(.vm.endpoint) | (.chaincode.externalBuilders[] | select(.name == "ccaas_builder") | .path) = ("${HOME}/fabric-builders/ccaas" | envsubst(ne)) | .chaincode.externalBuilders += { "name": "k8s_builder", "path": "${HOME}/fabric-builders/k8s" | envsubst(ne), "propagateEnvironment": [ "CORE_PEER_ID", "KUBECONFIG_PATH" ] }' -i "$HOME/fabric-samples/config/core.yaml" 207 | 208 | # TODO don't have permission to do this! Move to write-file or use a home bin directory? 209 | # wget -qO- https://raw.githubusercontent.com/hyperledgendary/package-k8s-chaincode-action/main/pkgk8scc.sh > /usr/local/bin/pkgk8scc && chmod 0755 /usr/local/bin/pkgk8scc 210 | 211 | runcmd: 212 | - wget -P /tmp/ https://go.dev/dl/go1.18.7.linux-arm64.tar.gz 213 | - tar -C /usr/local -xzf /tmp/go1.18.7.linux-arm64.tar.gz 214 | - rm /tmp/go1.18.7.linux-arm64.tar.gz 215 | - GOPATH=/usr/local/go HOME=/root /usr/local/go/bin/go install sigs.k8s.io/kind@v0.16.0 216 | # Note: Cannot install later version of k9s this way due to https://github.com/derailed/k9s/issues/1484 217 | - GOPATH=/usr/local/go HOME=/root /usr/local/go/bin/go install github.com/derailed/k9s@v0.25.2 218 | - GOPATH=/usr/local/go HOME=/root /usr/local/go/bin/go install github.com/mikefarah/yq/v4@v4.28.1 219 | - curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh | bash -s -- --to /usr/local/bin 220 | - su -c "wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash" ubuntu 221 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------