sshkeyshare/README.md

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