User Getting Started
This section describes how to set up your account, organization, assemblies.
To set up your user account, follow these steps:
- Login/Register in OneOps to access/create your Organization.
- If necessary, ask an administrative user e.g. your manager, whether your team already has an organization created
in OneOps and request to be added to the appropriate organization.
- If you are on-boarding as part of a new organization, ask your manager to add you to the appropriate team.
- Not seeing your Organization? Look up the Organization you are interested in and ask an administrator to grant you access .
- Accept the Terms and Conditions, if it is your first time using OneOps.
- Click profile (your user name) on the left nav bar.
- Select Organization tab.
- Select new Organization from the right side.
- Enter Organization name and click save.
- This will bootstrap an Organization with reasonable defaults which can be changed later.
Normally administrator of the organization creates a cloud, it may require creating an
inductor or adding cloud to an exiting inductor.
- Create Organization if one does not exist.
- Click clouds link on left nav bar .
- Click Add Cloud
Next Create Assembly
Create an Assembly
Assembly is workspace for you application. To create an assembly
- Click Assemblies from left nav or top nav .
- In the assemblies listing page click New Assembly on the right hand side
or towards the end of listing.
- Enter assembly details, Click save. Next Create a Platform
To learn about additional Account activities for assemblies, teams, users and notifications refer to:
OneOps Design Phase
In the design phase, one can create platforms (building blocks) from existing available packs.
In this example, we will create simple application (Tomcat) which talks to back end database.
Create a Platform
- Click design (icon) from left nav or top nav or wizard.
- Click New Platform, choose from existing packs in pack name
- Modify any attributes of component to suit your application design.
Commit a design
- Click review to your changes, all changes are buffered in a release and are not applied unless you commit.
- Once satisfied click commit to commit the changes . Next [Create Environment]
- Change attributes of component which are common across environments.
- Add optional components /attachments in design phase.
Transition is where you define environment specific attributes as needed. The dev or qa environments may differ in terms of availability , resources needed and can be defined at environment level.
Create an Environment
- Click environment (icon) from left nav or top nav or wizard.
- Click New Environment .
- Select availability mode for your environment either at platform.
- Modify any attributes of components which may differ from design.
For example qa environment compute size requirements may differ from development/test or production environment, in such scenario you may choose default compute size based on what matches most of the environment requirements.
It’s not uncommon to choose development environment compute size as default for design which allows you to create multiple test environments without changing design.
This helps in creating environments faster without changing too many attributes at design level. As a best practice try
to have most used configuration in design. Also see variables
Lock any environment specific attributes to prevent the environment changes
to be override from design pulls.
- Click review and commit and deploy your changes. Next Deploy.
Deploy an Application
commit and deploy Review the deployment plan generated by OneOps.
- Click on a particular step to know what change is going to be deployed.
- Want to change plan, discard and no changes would be deployed.
- If satisfied click green Deploy
It can take few minutes to deploy the application to cloud infrastructure selected during environment creation.
At this time One Ops is executing actual work orders on the cloud of your choice, switching clouds is then matter of adding clouds and shutting down clouds which may not be needed.
The successful deployment will create actual instances of components (computes,tomcats) on to cloud(s) chosen. Once you have running environment you would need to operate the environment which typically involves
- View the status of your overall application.
- View notifications, alerts, filter instances based on their state.
- Perform operational activities on components level, like restart of all tomcats.
Some of the commonly used operations but not limited to these
- Replace of compute in case of hardware failures.
- Restart of services.(tomcat, Cassandra, elastic search)
- Some of attachments can be exposed as operations. Some of the
popular one used are taking nodes out of traffic.
- Redeploy artifacts.
- Log Searches on volume components.
- Control auto-repair / auto-scale.
- Perform repairs at cloud level.
- OneOps by default will send emails (default notification mechanism) if any of components are in unhealthy or notify
state. see Monitors
- If auto-repair is enabled, OneOps will auto-repair the instance. The actions taken to recover an instance are prescribed by
repair recipe of the component. For example, if Compute is alerting for missing heartbeat by default Computes repair action involves the following
- Check the ssh port
- If not able to connect after timeout, it will attempt reboot.
- These might recover the compute, if not then auto-replace would be triggered.
OneOps Documentation for Users
Before You Start with OneOps
Before you start with OneOps, it is recommended that you read the following documentation. It is the most essential information you need to begin well.
- Overview: OneOps business-level description of main benefits versus alternative solutions
- Key Concepts: Conceptual description and diagrams of how OneOps works
- Getting Started: How to start using OneOps (this section)
- Best Practices: How you should use OneOps for best results