From 548ac25b9df03821801bc77f737d332c13806cf0 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Thu, 31 Aug 2017 16:46:09 +0200 Subject: [PATCH] Unify license statements at markdown files Signed-off-by: Oliver Kopp --- docs/dev/CodeHeaders.md | 19 ++-- docs/dev/Encoding.md | 8 +- docs/dev/RepositoryLayout.md | 8 +- docs/dev/RepositoryUI.md | 11 +-- docs/dev/ToolChain.md | 11 +++ docs/dev/angular-ui.md | 7 +- docs/dev/config/Eclipse/README.md | 13 +-- docs/dev/config/IntelliJ IDEA/README.md | 13 ++- docs/user/DASpecification.md | 10 +- docs/user/Splitting.md | 10 +- docs/user/TopologyCompletion.md | 7 +- docs/user/TopologyCompletionTutorial.md | 7 +- docs/user/XaaSPackager.md | 121 +++++++++++++----------- docs/user/index.md | 11 +++ 14 files changed, 147 insertions(+), 109 deletions(-) diff --git a/docs/dev/CodeHeaders.md b/docs/dev/CodeHeaders.md index 533dfe4afb..7a24d479fe 100644 --- a/docs/dev/CodeHeaders.md +++ b/docs/dev/CodeHeaders.md @@ -24,22 +24,17 @@ This file explains how to create and maintain copyright headers in source files. * Student: John Smith * Copyright (c) 2013 John Smith (University of Stuttgart). -# Full information +## Full information Full information is available at: http://www.eclipse.org/legal/copyrightandlicensenotice.php -# License -Copyright (c) 2014 University of Stuttgart. +## License + +Copyright (c) 2013-2017 University of Stuttgart. All rights reserved. This program and the accompanying materials are made available under the terms of the [Eclipse Public License v1.0] -and the [Apache License v2.0] which both accompany this distribution, -and are available at http://www.eclipse.org/legal/epl-v10.html -and http://www.apache.org/licenses/LICENSE-2.0 - -Contributors: -* Oliver Kopp - initial API and implementation - +and the [Apache License v2.0] which both accompany this distribution. - [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html - [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html + [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html + [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html diff --git a/docs/dev/Encoding.md b/docs/dev/Encoding.md index b24e897324..8d750712fb 100644 --- a/docs/dev/Encoding.md +++ b/docs/dev/Encoding.md @@ -56,7 +56,9 @@ Summary: Because the namespace is part of the used URIs and the ns itself is a U Copyright (c) 2017 University of Stuttgart. -All rights reserved. Made available under the terms of the [Eclipse Public License v1.0] and the [Apache License v2.0] which both accompany this distribution. +All rights reserved. This program and the accompanying materials +are made available under the terms of the [Eclipse Public License v1.0] +and the [Apache License v2.0] which both accompany this distribution. - [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html - [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html + [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html + [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html diff --git a/docs/dev/RepositoryLayout.md b/docs/dev/RepositoryLayout.md index 4dc41814dd..f359d4a901 100644 --- a/docs/dev/RepositoryLayout.md +++ b/docs/dev/RepositoryLayout.md @@ -110,7 +110,9 @@ The local name is sufficient as the namespace is given by the parent directory. Copyright (c) 2013-2017 University of Stuttgart. -All rights reserved. Made available under the terms of the [Eclipse Public License v1.0] and the [Apache License v2.0] which both accompany this distribution. +All rights reserved. This program and the accompanying materials +are made available under the terms of the [Eclipse Public License v1.0] +and the [Apache License v2.0] which both accompany this distribution. - [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html - [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html + [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html + [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html diff --git a/docs/dev/RepositoryUI.md b/docs/dev/RepositoryUI.md index 17dd2a2bdd..bc946689bb 100644 --- a/docs/dev/RepositoryUI.md +++ b/docs/dev/RepositoryUI.md @@ -55,12 +55,7 @@ Copyright (c) 2017 University of Stuttgart. All rights reserved. This program and the accompanying materials are made available under the terms of the [Eclipse Public License v1.0] -and the [Apache License v2.0] which both accompany this distribution, -and are available at http://www.eclipse.org/legal/epl-v10.html -and http://www.apache.org/licenses/LICENSE-2.0 +and the [Apache License v2.0] which both accompany this distribution. -Contributors: -* Lukas Harzentter - initial API and implementation - - [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html - [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html + [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html + [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html diff --git a/docs/dev/ToolChain.md b/docs/dev/ToolChain.md index b1e107f990..1b869ce80c 100644 --- a/docs/dev/ToolChain.md +++ b/docs/dev/ToolChain.md @@ -123,3 +123,14 @@ For that, create a pull request to https://github.com/opentosca/winery to enable ![ExcursusGit](graphics/ExcursusGit.png) [gitk]: https://lostechies.com/joshuaflanagan/2010/09/03/use-gitk-to-understand-git/ + +## License + +Copyright (c) 2017 University of Stuttgart. + +All rights reserved. This program and the accompanying materials +are made available under the terms of the [Eclipse Public License v1.0] +and the [Apache License v2.0] which both accompany this distribution. + + [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html + [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html diff --git a/docs/dev/angular-ui.md b/docs/dev/angular-ui.md index bce7bda719..7009ba1a74 100644 --- a/docs/dev/angular-ui.md +++ b/docs/dev/angular-ui.md @@ -74,6 +74,7 @@ Copyright (c) 2017 University of Stuttgart. All rights reserved. This program and the accompanying materials are made available under the terms of the [Eclipse Public License v1.0] -and the [Apache License v2.0] which both accompany this distribution, -and are available at http://www.eclipse.org/legal/epl-v10.html -and http://www.apache.org/licenses/LICENSE-2.0 +and the [Apache License v2.0] which both accompany this distribution. + + [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html + [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html diff --git a/docs/dev/config/Eclipse/README.md b/docs/dev/config/Eclipse/README.md index 223b4c091f..03dcff7cf4 100644 --- a/docs/dev/config/Eclipse/README.md +++ b/docs/dev/config/Eclipse/README.md @@ -62,16 +62,11 @@ Copy `winery.properties` to `path-to-workspace\.metadata\.plugins\org.eclipse.ws ## License -Copyright (c) 2012-2014 University of Stuttgart. +Copyright (c) 2012-2017 University of Stuttgart. All rights reserved. This program and the accompanying materials are made available under the terms of the [Eclipse Public License v1.0] -and the [Apache License v2.0] which both accompany this distribution, -and are available at http://www.eclipse.org/legal/epl-v10.html -and http://www.apache.org/licenses/LICENSE-2.0 +and the [Apache License v2.0] which both accompany this distribution. -Contributors: -* Oliver Kopp - initial API and implementation - - [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html - [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html + [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html + [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html diff --git a/docs/dev/config/IntelliJ IDEA/README.md b/docs/dev/config/IntelliJ IDEA/README.md index da4ae92444..ae2c6228be 100644 --- a/docs/dev/config/IntelliJ IDEA/README.md +++ b/docs/dev/config/IntelliJ IDEA/README.md @@ -1,5 +1,3 @@ ---- ---- # IntelliJ Configuration Preparation: Generate a war to have all dependencies fetched by maven: `mvn package` @@ -41,3 +39,14 @@ Preparation: Generate a war to have all dependencies fetched by maven: `mvn pack - 2x Shift / Ctrl+Shift+F / Ctrl+F: Differrent forms of search - Ctrl+Alt+O: Organize imports (fixes checkstyle) - Ctrl+X: if nothing is marked: delete line and free space + +## License + +Copyright (c) 2017 University of Stuttgart. + +All rights reserved. This program and the accompanying materials +are made available under the terms of the [Eclipse Public License v1.0] +and the [Apache License v2.0] which both accompany this distribution. + + [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html + [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html diff --git a/docs/user/DASpecification.md b/docs/user/DASpecification.md index fba4e623c9..3fdea94264 100644 --- a/docs/user/DASpecification.md +++ b/docs/user/DASpecification.md @@ -15,9 +15,11 @@ As a result, arbitrary middleware can be injected and the respective driver is u ## License -Copyright (c) 2013-2017 University of Stuttgart. +Copyright (c) 2017 University of Stuttgart. -All rights reserved. Made available under the terms of the [Eclipse Public License v1.0] and the [Apache License v2.0] which both accompany this distribution. +All rights reserved. This program and the accompanying materials +are made available under the terms of the [Eclipse Public License v1.0] +and the [Apache License v2.0] which both accompany this distribution. - [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html - [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html + [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html + [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html diff --git a/docs/user/Splitting.md b/docs/user/Splitting.md index c21d93da2b..d0300ed22e 100644 --- a/docs/user/Splitting.md +++ b/docs/user/Splitting.md @@ -48,9 +48,11 @@ By using this function a vertical as well as horizontal matching is possible. ## License -Copyright (c) 2013-2017 University of Stuttgart. +Copyright (c) 2017 University of Stuttgart. -All rights reserved. Made available under the terms of the [Eclipse Public License v1.0] and the [Apache License v2.0] which both accompany this distribution. +All rights reserved. This program and the accompanying materials +are made available under the terms of the [Eclipse Public License v1.0] +and the [Apache License v2.0] which both accompany this distribution. - [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html - [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html + [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html + [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html diff --git a/docs/user/TopologyCompletion.md b/docs/user/TopologyCompletion.md index dcfcf85a13..95a483333d 100644 --- a/docs/user/TopologyCompletion.md +++ b/docs/user/TopologyCompletion.md @@ -80,9 +80,10 @@ Copyright (c) 2013-2017 University of Stuttgart. All rights reserved. This program and the accompanying materials are made available under the terms of the [Eclipse Public License v1.0] -and the [Apache License v2.0] which both accompany this distribution, -and are available at http://www.eclipse.org/legal/epl-v10.html -and http://www.apache.org/licenses/LICENSE-2.0 +and the [Apache License v2.0] which both accompany this distribution. + + [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html + [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html Contributors: * Pascal Hirmer - initial API and implementation diff --git a/docs/user/TopologyCompletionTutorial.md b/docs/user/TopologyCompletionTutorial.md index a6b5fc6bac..043f96330e 100644 --- a/docs/user/TopologyCompletionTutorial.md +++ b/docs/user/TopologyCompletionTutorial.md @@ -91,9 +91,10 @@ Copyright (c) 2013-2017 University of Stuttgart. All rights reserved. This program and the accompanying materials are made available under the terms of the [Eclipse Public License v1.0] -and the [Apache License v2.0] which both accompany this distribution, -and are available at http://www.eclipse.org/legal/epl-v10.html -and http://www.apache.org/licenses/LICENSE-2.0 +and the [Apache License v2.0] which both accompany this distribution. + + [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html + [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html Contributors: * Pascal Hirmer - initial API and implementation diff --git a/docs/user/XaaSPackager.md b/docs/user/XaaSPackager.md index d76035de19..e8241bc284 100644 --- a/docs/user/XaaSPackager.md +++ b/docs/user/XaaSPackager.md @@ -1,55 +1,66 @@ -# XaaS Packager - -## Motivation - -The goal of this feature is to provide an easy way to deploy a new Deployment Artifact (e.g. web application) by reusing an existing Service Template and replacing the Deployment Artifact in the specified Node Type with the new Deployment Artifact. - -## Enabling a ServiceTemplate to be reused with the XaaS Packager - -To enable a Service Template to be reusable by the XaaS Packager you can either: - -1. Create a new Service Template according to your requirements and specifications or -2. Use an already existing Service Template that satisfies your needs. - -However, in both cases you have to add the following Tags to the ServiceTemplate so the XaaS Packager can work with them: - -- **xaasPackageArtifactType** indicates the type of the artifact to be wrapped. -- **xaasPackageNode** indicates the nodeTemplate INSIDE a TAGGED ServiceTemplate to determine the destination where to inject the artifact into. -- **xaasPackageDeploymentArtifact** indicates a Deployment Artifact declared at the target Node (xaasPackageNode) which will be replaced by the given artefact. - -To add the necessary Tags to a ServiceTemplate the following steps have to be completed: - -1. In the Service Template view (click on Service Templates on the top of the page), choose the Service Template to be enabled to be used by the XaaS Packager. -2. Click on the *Tags* tab then click on the *add* button above the table to add new Tags to the Service Template. -3. In the add dialog that shows the following inputs: - - **Name** specifying the name of the tag (xaasPackageArtifactType, xaasPackageNode, xaasPackageDeploymentArtifact). - - **Value** the corresponding value for each tag. -4. After entering the desired name and value for a tag, click the add button that generates and saves the tag to the ServiceTemplate. - -The steps 2-4 have to be completed for each of the XaaS Packager specific tags specified above. - - - -For example, the input of: -- **name:** xaasPackageArtifactType, **value:** {http://docs.oasis-open.org/tosca/ns/2011/12/ToscaBaseTypes} -- **name:** xaasPackageDeploymentArtifact, **value:** HelloWorldDA -- **name:** xaasPackageNode, **value:** PythonApp_2_7 - - - would generate the xml: - - ``` xml - -``` -## XaaS Packger with Winery -The functionality of the XaaS Packager is available in the Winery application and can be used as follows: - - -1. click on the tab *ServiceTemplates* at the top of the page. -2. then click on the button *create from artifact* from the menu to the right. A dialog will show up contaning the following inputs: -- **Type**: the user has to select the appropriate Artifact Type out of the available *xaasPackagerArtifactTypes*. -- **Select Artifact**: here u can upload the Deployment Artifact that will replace the existing Artifact in the specified Node Type. -- **Tags**: additional tags can be added to the Service Template. -- **NodeTypes**(optional): allows the selection of additional Node Types that MUST be used inside the selected topology. - -After setting all required inputs, a click on the *add* button trigger a search for a suitable cloud topology into which the artifact can be wrapped. +# XaaS Packager + +## Motivation + +The goal of this feature is to provide an easy way to deploy a new Deployment Artifact (e.g. web application) by reusing an existing Service Template and replacing the Deployment Artifact in the specified Node Type with the new Deployment Artifact. + +## Enabling a ServiceTemplate to be reused with the XaaS Packager + +To enable a Service Template to be reusable by the XaaS Packager you can either: + +1. Create a new Service Template according to your requirements and specifications or +2. Use an already existing Service Template that satisfies your needs. + +However, in both cases you have to add the following Tags to the ServiceTemplate so the XaaS Packager can work with them: + +- **xaasPackageArtifactType** indicates the type of the artifact to be wrapped. +- **xaasPackageNode** indicates the nodeTemplate INSIDE a TAGGED ServiceTemplate to determine the destination where to inject the artifact into. +- **xaasPackageDeploymentArtifact** indicates a Deployment Artifact declared at the target Node (xaasPackageNode) which will be replaced by the given artefact. + +To add the necessary Tags to a ServiceTemplate the following steps have to be completed: + +1. In the Service Template view (click on Service Templates on the top of the page), choose the Service Template to be enabled to be used by the XaaS Packager. +2. Click on the *Tags* tab then click on the *add* button above the table to add new Tags to the Service Template. +3. In the add dialog that shows the following inputs: + - **Name** specifying the name of the tag (xaasPackageArtifactType, xaasPackageNode, xaasPackageDeploymentArtifact). + - **Value** the corresponding value for each tag. +4. After entering the desired name and value for a tag, click the add button that generates and saves the tag to the ServiceTemplate. + +The steps 2-4 have to be completed for each of the XaaS Packager specific tags specified above. + + + +For example, the input of: +- **name:** xaasPackageArtifactType, **value:** {http://docs.oasis-open.org/tosca/ns/2011/12/ToscaBaseTypes} +- **name:** xaasPackageDeploymentArtifact, **value:** HelloWorldDA +- **name:** xaasPackageNode, **value:** PythonApp_2_7 + + + would generate the xml: + + ``` xml + +``` +## XaaS Packger with Winery +The functionality of the XaaS Packager is available in the Winery application and can be used as follows: + + +1. click on the tab *ServiceTemplates* at the top of the page. +2. then click on the button *create from artifact* from the menu to the right. A dialog will show up contaning the following inputs: +- **Type**: the user has to select the appropriate Artifact Type out of the available *xaasPackagerArtifactTypes*. +- **Select Artifact**: here u can upload the Deployment Artifact that will replace the existing Artifact in the specified Node Type. +- **Tags**: additional tags can be added to the Service Template. +- **NodeTypes**(optional): allows the selection of additional Node Types that MUST be used inside the selected topology. + +After setting all required inputs, a click on the *add* button trigger a search for a suitable cloud topology into which the artifact can be wrapped. + +## License + +Copyright (c) 2017 University of Stuttgart. + +All rights reserved. This program and the accompanying materials +are made available under the terms of the [Eclipse Public License v1.0] +and the [Apache License v2.0] which both accompany this distribution. + + [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html + [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html diff --git a/docs/user/index.md b/docs/user/index.md index f18a8ace05..68382689e7 100644 --- a/docs/user/index.md +++ b/docs/user/index.md @@ -29,3 +29,14 @@ The repository is also responsible for importing and exporting CSARs, the excha - [Splitting](Splitting) - splitting functionality - [TopologyCompletion](TopologyCompletion) - topology completion with a [Tutorial](TopologyCompletionTutorial) - [XaaSPackager](XaaSPackager) - Enables reusing modeled topologies as templates for single applications + +## License + +Copyright (c) 2017 University of Stuttgart. + +All rights reserved. This program and the accompanying materials +are made available under the terms of the [Eclipse Public License v1.0] +and the [Apache License v2.0] which both accompany this distribution. + + [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html + [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html