Centralize readthedocs docs
[ccsdk/distribution.git] / docs / platform / plugins / sshkeyshare.rst
1 .. raw:: html
2
3    <!--
4    ============LICENSE_START=======================================================
5    org.onap.ccsdk
6    ================================================================================
7    Copyright (c) 2017 AT&T Intellectual Property. All rights reserved.
8    ================================================================================
9    Licensed under the Apache License, Version 2.0 (the "License");
10    you may not use this file except in compliance with the License.
11    You may obtain a copy of the License at
12
13         http://www.apache.org/licenses/LICENSE-2.0
14
15    Unless required by applicable law or agreed to in writing, software
16    distributed under the License is distributed on an "AS IS" BASIS,
17    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18    See the License for the specific language governing permissions and
19    limitations under the License.
20    ============LICENSE_END=========================================================
21    -->
22
23 sshkeyshare plugin
24 ==================
25
26 Cloudify plugin for creating ssh key pairs on the fly # Description The
27 sshkeyshare Cloudify plugin creates an ssh key pair that can be used, by
28 VMs or other containers spun up by a Cloudify blueprint, for
29 establishing connections, among them. The blue print can, for example,
30 provide the private key to one VM and the public one to another, as part
31 of their initial configuration, to allow the one with the private key to
32 automatically connect to the other one, to run commands. # Plugin
33 Requirements \* Python versions \* 2.7.x
34
35 Note: These requirements apply to the VM where Cloudify Manager itself
36 runs.
37
38 Note: Cloudify Manager, itself, requires Pythong 2.7.x (and CentOS 7).
39
40 Types
41 =====
42
43 ccsdk.nodes.ssh.keypair
44 -----------------------
45
46 **Derived From:** cloudify.nodes.Root
47
48 **Properties:** This type has no properties
49
50 **Mapped Operations:** \* ``cloudify.interfaces.lifecycle.create``
51 Creates a new ssh keypair using ssh-keygen
52
53 **Attributes:** \* ``public`` A string containing the public key of the
54 newly created keypair. \* ``base64private`` A single line base-64
55 encoded representation of the content of the private key file for the
56 newly created keypair.
57
58 Relationships
59 =============
60
61 This plugin does not define or use any relationships