diff --git a/content/trial_getting_started/getting_started_wizard/_index.md b/content/trial_getting_started/getting_started_wizard/_index.md new file mode 100644 index 000000000..2ec6e2c25 --- /dev/null +++ b/content/trial_getting_started/getting_started_wizard/_index.md @@ -0,0 +1,71 @@ ++++ +title = "Getting Started Wizard" +description = "Getting started wizard" +weight = 97 +alwaysopen = false ++++ + +OK, so you have your {{< param cfy_manager_name >}} setup ready. When you login to the {{< param cfy_manager_name >}} for first time a getting started wizard is presented. +Note: The wizard will be shown only for admin users as it requires installing plugins, secrets and blueprints. + +![1_getting_started.png]( /images/getting_started/1_getting_started.png ) + +The wizard will assist you with setting up your {{< param cfy_manager_name >}} with installing plugins, secrets and blueprints. + +You can select multiple technologies and install all the required resources at once. + +Find below the supported technologies, you can find out what resources are installed as part of it by clicking on each one of them: + +* [AWS]({{< relref "/trial_getting_started/getting_started_wizard/aws.md" >}}) +* [GCP]({{< relref "/trial_getting_started/getting_started_wizard/gcp.md" >}}) +* [Openstack v3]({{< relref "/trial_getting_started/getting_started_wizard/openstack.md" >}}) +* [Azure]({{< relref "/trial_getting_started/getting_started_wizard/azure.md" >}}) +* [vCloud]({{< relref "/trial_getting_started/getting_started_wizard/vcloud.md" >}}) +* [vSphere]({{< relref "/trial_getting_started/getting_started_wizard/vsphere.md" >}}) +* [Terraform on AWS]({{< relref "/trial_getting_started/getting_started_wizard/terraform_on_aws.md" >}}) +* [Ansible on AWS]({{< relref "/trial_getting_started/getting_started_wizard/ansible_on_aws.md" >}}) + +In the main window you will have an option to select one or many technologies and continue by pressing the `Next` button. + +![2_getting_started_technologies.png]( /images/getting_started/2_getting_started_technologies.png ) + +If your selection requires secrets you'll be promoted to a step to set up secrets. If you selected more than one technology you might have a several steps to set up the secrets. + +To continue you'll need to feel all the required fields and continue by pressing the `Next` button. + +![3_getting_started_aws_secrets.png]( /images/getting_started/3_getting_started_aws_secrets.png ) + +In the end you'll be shown a summary to review the changes that will be applied, to confirm press `Finish` button. + + +![4_getting_started_summary.png]( /images/getting_started/4_getting_started_summary.png ) + +If the secrets you are setting up already exists the summary will notify that they will be updated. + +![4_1_getting_started_summary_secret_update.png]( /images/getting_started/4_1_getting_started_summary_secret_update.png ) + +In case the resources already exists it will be reflected in the summary step with the green check mark near by the installed resource. + +![4_2_gettinng_started_preinstalled_resources.png]( /images/getting_started/4_2_gettinng_started_preinstalled_resources.png ) + +Once you confirm you'll be promoted to the installation phase. The progress bar will be shown in the bottom of the step. + +When the bar shows 100% you can close the window and you are ready to create your first deployment. + +![6_getting_started_status_complete.png]( /images/getting_started/6_getting_started_status_complete.png ) + +You can close the wizard and and proceed to create your first deployment. + +## Disable Getting started Wizard +The getting started wizard will pop up each time you log in. In case you want to disable it you have two options. + +The first option is by checking the box `Don't show next time` inside the wizard. Either you close the wizard or finish the flow with the checkbox the wizard won't appear the next time. + +![7_getting_started_dont_show_next_time.png]( /images/getting_started/7_getting_started_dont_show_next_time.png ) + +## Enable Getting started wizard +The getting started wizard can be enabled or disabled through the user management widget as well. + +To enable the getting started wizard please navigate to user management and check the box in the `Getting Started` column for a relevant user. + +![8_getting_started_enable_wizard.png]( /images/getting_started/8_getting_started_enable_wizard.png ) diff --git a/content/trial_getting_started/getting_started_wizard/ansible_on_aws.md b/content/trial_getting_started/getting_started_wizard/ansible_on_aws.md new file mode 100644 index 000000000..fc9f1b70f --- /dev/null +++ b/content/trial_getting_started/getting_started_wizard/ansible_on_aws.md @@ -0,0 +1,32 @@ ++++ +title = "Ansible on AWS" +description = "Getting started wizard Ansible on AWS" +weight = 170 +alwaysopen = false ++++ + +The document describes the wizard steps and resources when Ansible on AWS technology is selected. + +When you select Ansible on AWS technology the following resources will be downloaded and configured. + +## Plugins + +The following plugins will be installed: + +* [cloudify-aws-plugin]({{< relref "/working_with/official_plugins/infrastructure/aws.md" >}}) +* [cloudify-utilities-plugin]({{< relref "/working_with/official_plugins/utilities/_index.md" >}}) +* [cloudify-ansible-plugin]({{< relref "/working_with/official_plugins/orchestration/ansible.md" >}}) + + +## Blueprints + +The following blueprints will be installed: + +* AWS-Basics-Simple-Service-Setup (aws.yaml) (https://github.com/cloudify-community/blueprint-examples/releases/download/latest/hello-world-example.zip) + +## Secrets + +The following secrets will be created. The value in parentheses is the secret name that will be created: + +* AWS Access Key ID (aws_access_key_id) +* AWS Secret Access Key (aws_secret_access_key) diff --git a/content/trial_getting_started/getting_started_wizard/aws.md b/content/trial_getting_started/getting_started_wizard/aws.md new file mode 100644 index 000000000..483e38696 --- /dev/null +++ b/content/trial_getting_started/getting_started_wizard/aws.md @@ -0,0 +1,35 @@ ++++ +title = "AWS" +description = "Getting started wizard AWS" +weight = 100 +alwaysopen = false ++++ + +The document describes the wizard steps and resources when AWS technology is selected. + +When you select AWS technology the following resources will be downloaded and configured. + +## Plugins + +The following plugins will be installed: + +* [cloudify-aws-plugin]({{< relref "/working_with/official_plugins/infrastructure/aws.md" >}}) +* [cloudify-utilities-plugin]({{< relref "/working_with/official_plugins/utilities/_index.md" >}}) +* [cloudify-kubernetes-plugin]({{< relref "/working_with/official_plugins/orchestration/kubernetes.md" >}}) + + +## Blueprints + +The blueprints bellow will be installed, to get more information regarding the blueprint and how manually to install it click on the blueprint. + +* [AWS-Basics-VM-Setup]({{< relref "/trial_getting_started/examples/basic/aws_basics.md" >}}) +* [AWS-VM-Setup-using-CloudFormation]({{< relref "/trial_getting_started/examples/automation_tools/aws_cloudformation_basics.md" >}}) +* Kubernetes-AWS-EKS + + +## Secrets + +The following secrets will be created. The value in parentheses is the secret name that will be created: + +* AWS Access Key ID (aws_access_key_id) +* AWS Secret Access Key (aws_secret_access_key) \ No newline at end of file diff --git a/content/trial_getting_started/getting_started_wizard/azure.md b/content/trial_getting_started/getting_started_wizard/azure.md new file mode 100644 index 000000000..f0c56cc7a --- /dev/null +++ b/content/trial_getting_started/getting_started_wizard/azure.md @@ -0,0 +1,37 @@ ++++ +title = "Azure" +description = "Getting started wizard Azure" +weight = 120 +alwaysopen = false ++++ + +The document describes the wizard steps and resources when Azure technology is selected. + +When you select Azure technology the following resources will be downloaded and configured. + +## Plugins + +The following plugins will be installed: + +* [cloudify-azure-plugin]({{< relref "/working_with/official_plugins/infrastructure/azure.md" >}}) +* [cloudify-utilities-plugin]({{< relref "/working_with/official_plugins/utilities/_index.md" >}}) +* [cloudify-kubernetes-plugin]({{< relref "/working_with/official_plugins/orchestration/kubernetes.md" >}}) + + +## Blueprints + +The blueprints bellow will be installed, to get more information regarding the blueprint and how manually to install it click on the blueprint. + +* [Azure-Basics-VM-Setup]({{< relref "/trial_getting_started/examples/basic/azure_basics" >}}) +* [Azure-Basics-Simple-Service-Setup]({{< relref "/trial_getting_started/examples/first_service/azure_hello_world_example.md" >}}) +* [Azure-VM-Setup-using-ARM]({{< relref "/trial_getting_started/examples/automation_tools/azure_arm_basics.md" >}}) +* Kubernetes-Azure-AKS + +## Secrets + +The following secrets will be created. The value in parentheses is the secret name that will be created: + +* Azure Subscription ID (azure_subscription_id) +* Azure Tenant ID (azure_tenant_id) +* Azure Client ID (azure_client_id) +* Azure Client Secret (azure_client_secret) \ No newline at end of file diff --git a/content/trial_getting_started/getting_started_wizard/gcp.md b/content/trial_getting_started/getting_started_wizard/gcp.md new file mode 100644 index 000000000..7d2980934 --- /dev/null +++ b/content/trial_getting_started/getting_started_wizard/gcp.md @@ -0,0 +1,39 @@ ++++ +title = "GCP" +description = "Getting started wizard GCP" +weight = 100 +alwaysopen = false ++++ + +The document describes the wizard steps and resources when GCP technology is selected. + +When you select GCP technology the following resources will be downloaded and configured. + +## Plugins + +The following plugins will be installed: + +* [cloudify-gcp-plugin]({{< relref "/working_with/official_plugins/infrastructure/gcp.md" >}}) +* [cloudify-utilities-plugin]({{< relref "/working_with/official_plugins/utilities/_index.md" >}}) +* [cloudify-kubernetes-plugin]({{< relref "/working_with/official_plugins/orchestration/kubernetes.md" >}}) + + +## Blueprints + +The blueprints bellow will be installed, to get more information regarding the blueprint and how manually to install it click on the blueprint. + +* [GCP-Basics-VM-Setup]({{< relref "/trial_getting_started/examples/basic/gcp_basics.md" >}}) +* [GCP-Basics-Simple-Service-Setup]({{< relref "/trial_getting_started/examples/first_service/gcp_hello_world_example.md" >}}) +* Kubernetes-GCP-GKE + +## Secrets + +The following secrets will be created. The value in parentheses is the secret name that will be created: + +* GCP Client_x509 Certificate URL (gcp_client_x509_cert_url) +* GCP Client E-mail (gcp_client_email) +* GCP Client ID (gcp_client_id) +* GCP Project ID (gcp_project_id) +* GCP Private Key ID (gcp_private_key_id) +* GCP Private Key (gcp_private_key) +* GCP Zone (gcp_zone) \ No newline at end of file diff --git a/content/trial_getting_started/getting_started_wizard/openstack.md b/content/trial_getting_started/getting_started_wizard/openstack.md new file mode 100644 index 000000000..59ae54ce6 --- /dev/null +++ b/content/trial_getting_started/getting_started_wizard/openstack.md @@ -0,0 +1,35 @@ ++++ +title = "Openstack v3" +description = "Getting started wizard Openstack v3" +weight = 130 +alwaysopen = false ++++ + +The document describes the wizard steps and resources when Openstack v3 technology is selected. + +When you select Openstack v3 technology the following resources will be downloaded and configured. + +## Plugins + +The following plugins will be installed: + +* [cloudify-openstack-plugin]({{< relref "/working_with/official_plugins/infrastructure/openstackv3.md" >}}) +* [cloudify-utilities-plugin]({{< relref "/working_with/official_plugins/utilities/_index.md" >}}) + + +## Blueprints + +The blueprints bellow will be installed, to get more information regarding the blueprint and how manually to install it click on the blueprint. + +* [OpenStack-Basics-VM-Setup]({{< relref "/trial_getting_started/examples/basic/openstack_basics.md" >}}) +* [OpenStack-Basics-Simple-Service-Setup]({{< relref "/trial_getting_started/examples/first_service/openstack_hello_world_example" >}}) + +## Secrets + +The following secrets will be created. The value in parentheses is the secret name that will be created: + +* Openstack Username (openstack_username) +* Openstack Password (openstack_password) +* Openstack Auth Url (openstack_auth_url) +* Openstack Project Name (openstack_project_name) +* Openstack Tenant Name (openstack_tenant_name) \ No newline at end of file diff --git a/content/trial_getting_started/getting_started_wizard/terraform_on_aws.md b/content/trial_getting_started/getting_started_wizard/terraform_on_aws.md new file mode 100644 index 000000000..9d09e7b67 --- /dev/null +++ b/content/trial_getting_started/getting_started_wizard/terraform_on_aws.md @@ -0,0 +1,33 @@ ++++ +title = "Terraform on AWS" +description = "Getting started wizard Terraform on AWS" +weight = 160 +alwaysopen = false ++++ + +The document describes the wizard steps and resources when Terraform on AWS technology is selected. + +When you select Terraform on AWS technology the following resources will be downloaded and configured. + +## Plugins + +The following plugins will be installed: + +* [cloudify-aws-plugin]({{< relref "/working_with/official_plugins/infrastructure/aws.md" >}}) +* [cloudify-utilities-plugin]({{< relref "/working_with/official_plugins/utilities/_index.md" >}}) +* [cloudify-terraform-plugin]({{< relref "/working_with/official_plugins/orchestration/terraform.md" >}}) + + +## Blueprints + +The blueprints bellow will be installed, to get more information regarding the blueprint and how manually to install it click on the blueprint. + +* [AWS-VM-Setup-using-Terraform]({{< relref "/trial_getting_started/examples/automation_tools/aws_terraform_basics.md" >}}) + + +## Secrets + +The following secrets will be created. The value in parentheses is the secret name that will be created: + +* AWS Access Key ID (aws_access_key_id) +* AWS Secret Access Key (aws_secret_access_key) \ No newline at end of file diff --git a/content/trial_getting_started/getting_started_wizard/vcloud.md b/content/trial_getting_started/getting_started_wizard/vcloud.md new file mode 100644 index 000000000..872b31fde --- /dev/null +++ b/content/trial_getting_started/getting_started_wizard/vcloud.md @@ -0,0 +1,33 @@ ++++ +title = "vCloud" +description = "Getting started wizard vCloud" +weight = 140 +alwaysopen = false ++++ + +The document describes the wizard steps and resources when vCloud technology is selected. + +When you select vCloud technology the following resources will be downloaded and configured. + +## Plugins + +The following plugins will be installed: + +* [cloudify-vcloud-plugin]({{< relref "/working_with/official_plugins/infrastructure/vcloud.md" >}}) + + +## Blueprints + +The following blueprints will be installed: +None + +## Secrets + +The following secrets will be created. The value in parentheses is the secret name that will be created: + +* vCloud User (vcloud_user) +* vCloud Password (vcloud_password) +* vCloud Organization (vcloud_org) +* vCloud URI (vcloud_uri) +* vCloud Virtual Data Center (vDC) (vcloud_vdc) +* vCloud Gateway (vcloud_gateway) \ No newline at end of file diff --git a/content/trial_getting_started/getting_started_wizard/vsphere.md b/content/trial_getting_started/getting_started_wizard/vsphere.md new file mode 100644 index 000000000..ced7faefa --- /dev/null +++ b/content/trial_getting_started/getting_started_wizard/vsphere.md @@ -0,0 +1,33 @@ ++++ +title = "vSphere" +description = "Getting started wizard vSphere" +weight = 150 +alwaysopen = false ++++ + +The document describes the wizard steps and resources when vCloud technology is selected. + +When you select vCloud technology the following resources will be downloaded and configured. + +## Plugins + +The following plugins will be installed: + +* [cloudify-vsphere-plugin]({{< relref "/working_with/official_plugins/infrastructure/vsphere.md" >}}) + + +## Blueprints + +The following blueprints will be installed: +None + +## Secrets + +The following secrets will be created. The value in parentheses is the secret name that will be created: + +* vSphere Username (vsphere_username) +* vSphere Password (vsphere_password) +* vSphere Host (vsphere_host) +* vSphere Datacenter Nameas (vsphere_datacenter_nameas) +* vSphere Resource Pool Name (vsphere_resource_pool_name) +* vSphere Auto Placement (vsphere_auto_placement) \ No newline at end of file diff --git a/static/images/getting_started/1_getting_started.png b/static/images/getting_started/1_getting_started.png new file mode 100644 index 000000000..867e6843e Binary files /dev/null and b/static/images/getting_started/1_getting_started.png differ diff --git a/static/images/getting_started/2_getting_started_technologies.png b/static/images/getting_started/2_getting_started_technologies.png new file mode 100644 index 000000000..fca1800a5 Binary files /dev/null and b/static/images/getting_started/2_getting_started_technologies.png differ diff --git a/static/images/getting_started/3_getting_started_aws_secrets.png b/static/images/getting_started/3_getting_started_aws_secrets.png new file mode 100644 index 000000000..5bb79bb5d Binary files /dev/null and b/static/images/getting_started/3_getting_started_aws_secrets.png differ diff --git a/static/images/getting_started/4_1_getting_started_summary_secret_update.png b/static/images/getting_started/4_1_getting_started_summary_secret_update.png new file mode 100644 index 000000000..e6185088a Binary files /dev/null and b/static/images/getting_started/4_1_getting_started_summary_secret_update.png differ diff --git a/static/images/getting_started/4_2_gettinng_started_preinstalled_resources.png b/static/images/getting_started/4_2_gettinng_started_preinstalled_resources.png new file mode 100644 index 000000000..54003d915 Binary files /dev/null and b/static/images/getting_started/4_2_gettinng_started_preinstalled_resources.png differ diff --git a/static/images/getting_started/4_getting_started_summary.png b/static/images/getting_started/4_getting_started_summary.png new file mode 100644 index 000000000..a15c85c22 Binary files /dev/null and b/static/images/getting_started/4_getting_started_summary.png differ diff --git a/static/images/getting_started/5_getting_started_status_progress.png b/static/images/getting_started/5_getting_started_status_progress.png new file mode 100644 index 000000000..445060387 Binary files /dev/null and b/static/images/getting_started/5_getting_started_status_progress.png differ diff --git a/static/images/getting_started/6_getting_started_status_complete.png b/static/images/getting_started/6_getting_started_status_complete.png new file mode 100644 index 000000000..9b13e6c5e Binary files /dev/null and b/static/images/getting_started/6_getting_started_status_complete.png differ diff --git a/static/images/getting_started/7_getting_started_dont_show_next_time.png b/static/images/getting_started/7_getting_started_dont_show_next_time.png new file mode 100644 index 000000000..0d8408e2a Binary files /dev/null and b/static/images/getting_started/7_getting_started_dont_show_next_time.png differ diff --git a/static/images/getting_started/8_getting_started_enable_wizard.png b/static/images/getting_started/8_getting_started_enable_wizard.png new file mode 100644 index 000000000..68e24f519 Binary files /dev/null and b/static/images/getting_started/8_getting_started_enable_wizard.png differ