diff --git a/index.rst b/index.rst index bab1bbb7..2a3ebdcb 100644 --- a/index.rst +++ b/index.rst @@ -112,6 +112,17 @@ Enterprise Documentation ee/index +SAAS Documentation +--------------------------- + +.. toctree:: + :maxdepth: 2 + + saas/index + + + + Advanced Server Installation ------------------------------- diff --git a/saas/images/saas-accept-invite.png b/saas/images/saas-accept-invite.png new file mode 100644 index 00000000..87d03155 Binary files /dev/null and b/saas/images/saas-accept-invite.png differ diff --git a/saas/images/saas-account-creation.png b/saas/images/saas-account-creation.png new file mode 100644 index 00000000..a9d9be8e Binary files /dev/null and b/saas/images/saas-account-creation.png differ diff --git a/saas/images/saas-billing-page.png b/saas/images/saas-billing-page.png new file mode 100644 index 00000000..d2eb7ebf Binary files /dev/null and b/saas/images/saas-billing-page.png differ diff --git a/saas/images/saas-change-name.png b/saas/images/saas-change-name.png new file mode 100644 index 00000000..6172d4f9 Binary files /dev/null and b/saas/images/saas-change-name.png differ diff --git a/saas/images/saas-close-account.png b/saas/images/saas-close-account.png new file mode 100644 index 00000000..132f8bc1 Binary files /dev/null and b/saas/images/saas-close-account.png differ diff --git a/saas/images/saas-delete-tenant.png b/saas/images/saas-delete-tenant.png new file mode 100644 index 00000000..ead4cdc3 Binary files /dev/null and b/saas/images/saas-delete-tenant.png differ diff --git a/saas/images/saas-downgrade-tenant.png b/saas/images/saas-downgrade-tenant.png new file mode 100644 index 00000000..60d09947 Binary files /dev/null and b/saas/images/saas-downgrade-tenant.png differ diff --git a/saas/images/saas-free-tier-dashboard.png b/saas/images/saas-free-tier-dashboard.png new file mode 100644 index 00000000..380282fb Binary files /dev/null and b/saas/images/saas-free-tier-dashboard.png differ diff --git a/saas/images/saas-invite-accepted.png b/saas/images/saas-invite-accepted.png new file mode 100644 index 00000000..d2eadcdc Binary files /dev/null and b/saas/images/saas-invite-accepted.png differ diff --git a/saas/images/saas-invite-sent.png b/saas/images/saas-invite-sent.png new file mode 100644 index 00000000..f17a4127 Binary files /dev/null and b/saas/images/saas-invite-sent.png differ diff --git a/saas/images/saas-invite-user.png b/saas/images/saas-invite-user.png new file mode 100644 index 00000000..2496b9c1 Binary files /dev/null and b/saas/images/saas-invite-user.png differ diff --git a/saas/images/saas-invoice-email.png b/saas/images/saas-invoice-email.png new file mode 100644 index 00000000..8970e2aa Binary files /dev/null and b/saas/images/saas-invoice-email.png differ diff --git a/saas/images/saas-invoice.png b/saas/images/saas-invoice.png new file mode 100644 index 00000000..06db3d66 Binary files /dev/null and b/saas/images/saas-invoice.png differ diff --git a/saas/images/saas-leave-tenant.png b/saas/images/saas-leave-tenant.png new file mode 100644 index 00000000..5aac6aa5 Binary files /dev/null and b/saas/images/saas-leave-tenant.png differ diff --git a/saas/images/saas-manage-account.png b/saas/images/saas-manage-account.png new file mode 100644 index 00000000..b4713233 Binary files /dev/null and b/saas/images/saas-manage-account.png differ diff --git a/saas/images/saas-name-tenant.png b/saas/images/saas-name-tenant.png new file mode 100644 index 00000000..9fcc742d Binary files /dev/null and b/saas/images/saas-name-tenant.png differ diff --git a/saas/images/saas-navigate-to-tenant.png b/saas/images/saas-navigate-to-tenant.png new file mode 100644 index 00000000..ec386290 Binary files /dev/null and b/saas/images/saas-navigate-to-tenant.png differ diff --git a/saas/images/saas-new-owner.png b/saas/images/saas-new-owner.png new file mode 100644 index 00000000..4b9ead87 Binary files /dev/null and b/saas/images/saas-new-owner.png differ diff --git a/saas/images/saas-remove-user.png b/saas/images/saas-remove-user.png new file mode 100644 index 00000000..383ed9ec Binary files /dev/null and b/saas/images/saas-remove-user.png differ diff --git a/saas/images/saas-reset-password.png b/saas/images/saas-reset-password.png new file mode 100644 index 00000000..caa731c4 Binary files /dev/null and b/saas/images/saas-reset-password.png differ diff --git a/saas/images/saas-select-tier.png b/saas/images/saas-select-tier.png new file mode 100644 index 00000000..5dd670e3 Binary files /dev/null and b/saas/images/saas-select-tier.png differ diff --git a/saas/images/saas-setup-payment.png b/saas/images/saas-setup-payment.png new file mode 100644 index 00000000..e6dc58fc Binary files /dev/null and b/saas/images/saas-setup-payment.png differ diff --git a/saas/images/saas-signup-link.png b/saas/images/saas-signup-link.png new file mode 100644 index 00000000..444f5fe4 Binary files /dev/null and b/saas/images/saas-signup-link.png differ diff --git a/saas/images/saas-stripe-add-payment.png b/saas/images/saas-stripe-add-payment.png new file mode 100644 index 00000000..e1e2cbb3 Binary files /dev/null and b/saas/images/saas-stripe-add-payment.png differ diff --git a/saas/images/saas-stripe-page.png b/saas/images/saas-stripe-page.png new file mode 100644 index 00000000..6bd90aeb Binary files /dev/null and b/saas/images/saas-stripe-page.png differ diff --git a/saas/images/saas-stripe-payment-entered.png b/saas/images/saas-stripe-payment-entered.png new file mode 100644 index 00000000..246998f6 Binary files /dev/null and b/saas/images/saas-stripe-payment-entered.png differ diff --git a/saas/images/saas-support-options.png b/saas/images/saas-support-options.png new file mode 100644 index 00000000..aaac9110 Binary files /dev/null and b/saas/images/saas-support-options.png differ diff --git a/saas/images/saas-support-tab.png b/saas/images/saas-support-tab.png new file mode 100644 index 00000000..90e0f920 Binary files /dev/null and b/saas/images/saas-support-tab.png differ diff --git a/saas/images/saas-switch-tenant-button.png b/saas/images/saas-switch-tenant-button.png new file mode 100644 index 00000000..848989ab Binary files /dev/null and b/saas/images/saas-switch-tenant-button.png differ diff --git a/saas/images/saas-transfer-ownership.png b/saas/images/saas-transfer-ownership.png new file mode 100644 index 00000000..025d4572 Binary files /dev/null and b/saas/images/saas-transfer-ownership.png differ diff --git a/saas/images/saas-update-user-permission.png b/saas/images/saas-update-user-permission.png new file mode 100644 index 00000000..c43f95ad Binary files /dev/null and b/saas/images/saas-update-user-permission.png differ diff --git a/saas/images/saas-upgrade-modal.png b/saas/images/saas-upgrade-modal.png new file mode 100644 index 00000000..ddc8b881 Binary files /dev/null and b/saas/images/saas-upgrade-modal.png differ diff --git a/saas/images/saas-upgrade-tenant.png b/saas/images/saas-upgrade-tenant.png new file mode 100644 index 00000000..6e207428 Binary files /dev/null and b/saas/images/saas-upgrade-tenant.png differ diff --git a/saas/images/saas-usage.png b/saas/images/saas-usage.png new file mode 100644 index 00000000..61cbf838 Binary files /dev/null and b/saas/images/saas-usage.png differ diff --git a/saas/images/saas-user-gone.png b/saas/images/saas-user-gone.png new file mode 100644 index 00000000..e53b9baa Binary files /dev/null and b/saas/images/saas-user-gone.png differ diff --git a/saas/images/saas-user-set-to-admin.png b/saas/images/saas-user-set-to-admin.png new file mode 100644 index 00000000..188bc83e Binary files /dev/null and b/saas/images/saas-user-set-to-admin.png differ diff --git a/saas/images/saas-users-location.png b/saas/images/saas-users-location.png new file mode 100644 index 00000000..133c5b8f Binary files /dev/null and b/saas/images/saas-users-location.png differ diff --git a/saas/images/saas-view-name.png b/saas/images/saas-view-name.png new file mode 100644 index 00000000..97b97fe3 Binary files /dev/null and b/saas/images/saas-view-name.png differ diff --git a/saas/index.rst b/saas/index.rst new file mode 100644 index 00000000..7a45af2d --- /dev/null +++ b/saas/index.rst @@ -0,0 +1,96 @@ +.. Netmaker documentation master file, created by + sphinx-quickstart on Fri May 14 08:51:40 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + + +.. image:: ../images/netmaker.png + :width: 100% + :alt: Netmaker WireGuard + :align: center + +=================================================== +Netmaker SAAS Documentation +=================================================== + +**Netmaker as a Service (NaaS) Documentation: Streamlining Networking for Modern Applications** + +Welcome to the comprehensive documentation for Netmaker as a Service (NaaS). This repository serves as your knowledge hub, providing in-depth insights and guidelines on how to leverage NaaS—a powerful Software-as-a-Service platform—to optimize your application's networking capabilities. + +**Introduction to NaaS:** + +Netmaker as a Service is a cloud-native networking solution designed to simplify the complexities of modern application networking. Built on the robust foundation of the open-source Netmaker project, NaaS empowers developers, DevOps engineers, and networking professionals with the tools needed to effortlessly orchestrate, secure, and scale their distributed systems. + +**Key Features and Benefits:** + +1. **User-Friendly Interface:** NaaS offers an intuitive web-based interface, enabling easy configuration and management of network resources. From service discovery to load balancing, NaaS streamlines your networking tasks, saving valuable time and effort. + +2. **Dynamic Scalability:** Seamlessly scale your infrastructure as your application grows. NaaS's dynamic provisioning ensures your network can adapt to fluctuating workloads and evolving demands. + +3. **Enhanced Security:** Protect your data and communication with built-in encryption, secure authentication, and private network segmentation. NaaS embraces a Zero Trust approach, ensuring only authorized entities can access your resources. + +4. **Multi-Cloud Connectivity:** Bridge the gap between different cloud providers and regions with NaaS. Establish secure connections across multi-cloud and hybrid cloud environments, enabling seamless collaboration and resource sharing. + +5. **Edge Computing Made Simple:** Extend your network to the edge with ease. NaaS facilitates secure communication between edge devices, IoT gateways, and centralized servers, unlocking the potential of real-time applications. + +Welcome to the world of Netmaker as a Service. Get ready to simplify, secure, and supercharge your networking infrastructure with NaaS, a truly powerful solution designed to empower your modern applications. Let's embark on this networking journey together and revolutionize the way we connect, collaborate, and innovate in the digital landscape. Happy networking! + +Account Signup +--------------- + +How to set up Netmaker as a Service + +.. toctree:: + :maxdepth: 2 + + saas-account-signup + +Profile Management +-------------------- + +.. toctree:: + :maxdepth: 2 + + saas-profile + +Tenant Management +------------------ + +.. toctree:: + :maxdepth: 2 + + saas-tenant + +Billing +-------- + +.. toctree:: + :maxdepth: 2 + + saas-billing + +User Management +---------------- + +.. toctree:: + :maxdepth: 2 + + saas-user + +Support +-------- + +.. toctree:: + :maxdepth: 2 + + saas-support + + +Troubleshooting +---------------- + +.. toctree:: + :maxdepth: 2 + + saas-troubleshoot + diff --git a/saas/saas-account-signup.rst b/saas/saas-account-signup.rst new file mode 100644 index 00000000..357bb277 --- /dev/null +++ b/saas/saas-account-signup.rst @@ -0,0 +1,30 @@ +================================= +Account Signup +================================= + +Welcome to Netmaker as a Service! Start your journey towards seamless and secure networking for your modern applications. + +`At the wecome page, `_ You will see a signup link at the bottom. Click that and use the signup method you would like to use. + +.. image:: images/saas-signup-link.png + :width: 80% + :alt: signup link at the bottom + :align: center + +You should then see a similar page with a confirm password text box. You can use Google or Github to instantly signup for an account. + +Using the traditional username/password method will send a confirmation email to you to verify. You will not be able to sign into your account without verifying through that email. + +After that, you should be able to sign in to your new account. You should see the following page while your account is being created. This is a 1-2 minute process while netmaker provisions a free tier server for you to start. + +.. image:: images/saas-account-creation.png + :width: 80% + :alt: loading screeen for account creation. + :align: center + +Once Netmaker is done with that, you will be redirected to the dashboard of your new Netmaker free tier instance. + +.. image:: images/saas-free-tier-dashboard.png + :width: 80% + :alt: dashboard for free tier NAAS instance + :align: center \ No newline at end of file diff --git a/saas/saas-billing.rst b/saas/saas-billing.rst new file mode 100644 index 00000000..6e0c7ae0 --- /dev/null +++ b/saas/saas-billing.rst @@ -0,0 +1,77 @@ +================================= +Billing +================================= + +The billing section is located in the account management in the billing and usage section + +.. image:: images/saas-billing-page.png + :width: 80% + :alt: saas billing page + :align: center + +This is where you enter payment information for your tenant, and view your usage and invoices. + +Setting up Payment +=================== + +In the billing and usage tab click on the ``manage your subscription in stripe`` button + +.. image:: images/saas-setup-payment.png + :width: 80% + :alt: navigate to stripe button + :align: center + +You should be brought to a stripe page that will allow you to enter card info. + +.. image:: images/saas-stripe-page.png + :width: 80% + :alt: stripe payment page + :align: center + +click on ``add payment method`` + +.. image:: images/saas-stripe-add-payment.png + :width: 80% + :alt: add your card to stripe + :align: center + +Enter your card information and submit. You should see your payment info on the screen. Click the ``return to netmaker`` button to go back to your saas account. + +.. image:: images/saas-stripe-payment-entered.png + :width: 80% + :alt: successful payment. go back to netmaker button + :align: center + +Each tenant needs its own payment. If you make another paid tier or self-hosted tenant, you will need to enter payment info for each tenant. + +Usage +======== + +You can see your tenant's usage on the right side of the screen. + +.. image:: images/saas-usage.png + :width: 80% + :alt: tenant usage section + :align: center + +This is updated hourly and will tell you how many of each resource is on that instance. + +Invoices +========= + +Invoices are sent out monthly. You can view your invoices on the billing and usage tab. + +.. image:: images/saas-invoice.png + :width: 80% + :alt: invoice section + :align: center + +You can see the invoice number, the amount, the date the invoice is issued and a status. If it is a failed status like the one in the example above, you may need to double check your payment info for accuracy, or contact us for troubleshooting. + +You will also get an email when your invoice is ready. + +.. image:: images/saas-invoice-email.png + :width: 80% + :alt: invoice section + :align: center + diff --git a/saas/saas-profile.rst b/saas/saas-profile.rst new file mode 100644 index 00000000..36cabbec --- /dev/null +++ b/saas/saas-profile.rst @@ -0,0 +1,43 @@ +===================================== +Profile Management +===================================== + +Change Name +============ + +Changing your name on your saas profile is easy. simply navigate to Manage Account and click on the profile button. + + +.. image:: images/saas-change-name.png + :width: 80% + :alt: signup link at the bottom + :align: center + +In the text boxes, change the first and last name to whatever you like, and click the save button. That name will now be saved as part of your profile. + +note: emails cannot be changed. If you would like to change your email, you will need to create an account with that different email, then you can transfer any tenants over to that account. To see how to transfer a tenant to another user, checkout :doc:`The users <./saas-user>` + +Change Password +================ + +In the same profile section, click on the reset password button. this will bring up a confirmation modal to send a password reset email to you. + +.. image:: images/saas-reset-password.png + :width: 80% + :alt: confirm password reset + :align: center + +After confirming the password reset, you will be redirected back to the login screen. Look for an email from ``Netmaker-Account-Manager noreply@supertokens.io``. You may need to look in your spam folder if it does not show up in your inbox. Follow the instructions in the email to reset your password. + + +Close Account +=============== + +To close out your account, just click the close acount button on your profile. + +.. image:: images/saas-close-account.png + :width: 80% + :alt: close account + :align: center + +This will remove all your tenants and information from that account and is not reversable. If there are any tenants you don't want permenantly removed, transfer them over to :doc:`Another user <./saas-user>` . \ No newline at end of file diff --git a/saas/saas-support.rst b/saas/saas-support.rst new file mode 100644 index 00000000..af5b4ad3 --- /dev/null +++ b/saas/saas-support.rst @@ -0,0 +1,28 @@ +===================================== +Support +===================================== + +Introduction +=============== + +Navigate to Account managemanet and click on the support tab + +.. image:: images/saas-support-tab.png + :width: 80% + :alt: support tab + :align: center + +You will see a few options. + +1) You can click on the discord button to recieve an invitation to join our discord server where you can ask for help. + +2) There is an email button to email us directly with any questions. + +3) The support button on the side menu will navigate you to the netmaker docs here. + +4) There is a chat icon in the bottom right corner. You can click that and a window will pop up. You can send us a message and we will respond as early as possible. + +.. image:: images/saas-support-options.png + :width: 80% + :alt: invoice section + :align: center \ No newline at end of file diff --git a/saas/saas-tenant.rst b/saas/saas-tenant.rst new file mode 100644 index 00000000..d9815895 --- /dev/null +++ b/saas/saas-tenant.rst @@ -0,0 +1,162 @@ +===================================== +Tenant Creation and Management +===================================== + +Introduction +=============== +Software as a Service (SaaS) has revolutionized the way businesses and individuals access and use software applications. SaaS offerings provide a cloud-based model where software is hosted and maintained by a service provider, and users can access these applications through the internet. Each individual or organization that subscribes to a SaaS service is referred to as a "tenant." + +Netmaker offers three types of tenants. Pricing for each tenant are listed on `our pricing page of our website `_ + +Free Tier +----------- + +Our free tier is what is built for you automatically when you sign up for our SAAS platform. There are limits to our free tier. They are listed on the link above. + +You can only have one free Tier tenant at a time per account. If you would like to get another free tier tenant, you will have to delete the existing one. + +Paid Tier +----------- + +Our paid tier has the same limits as the free tier. Instead, you will be charged for usage outside of those tier limits. pricing listed on link above. + +The paid tier has all the features of the pro version like meterics and relays. Once you create a paid tier tenant, you will have to enter payment information before you can use the paid tenant. Info on how to do that will be in our :doc:`billing section <./saas-billing>`. + + +Self Hosted +------------- + +Our self-hosted tier is where you will get your license key and tenant id to build a Netmaker Pro server. Instead of using a paid tier that is hosted on our cluster, you provide the server. This is paid only. There is no free tier for netmaker pro. + +Accessing Your tenants +======================= + +To access tenant management, navigate to manage account, + +.. image:: images/saas-manage-account.png + :width: 80% + :alt: manage account button + :align: center + +and bring up the bottom menu where you will see a ``switch tenant`` button. + +.. image:: images/saas-switch-tenant-button.png + :width: 80% + :alt: switch tenant button + :align: center + +This will bring you to a screen where you will see a list of all your tenants. + +Creating a Tenant +=================== + +To create a tenant, start at your switch tenant screen. There is a ``+ create tenant`` button. clicking that will pop up this modal. + +.. image:: images/saas-select-tier.png + :width: 80% + :alt: select tier modal + :align: center + +You'll have three choices of which tier to choose. If you already have a free tier, you will not be allowed to create another one unless you delete the existing free tier. + +You'll notice as well that the paid tier and self-hosted tier also have pricing info listed. After you make your selection, click on the 2 button above the self-hosted box to name your tenant. This name can be changed at any point in the settings. + +.. image:: images/saas-name-tenant.png + :width: 80% + :alt: name your tenant + :align: center + +After you enter a name, click the ``create`` button and your tenant is now in the list. You may see a status of ``unavailable`` at first. This is normal. Netmaker is building your instance at that time. After a few minutes, click the ``refresh status`` button above the list to see if that status goes away. If the ``unavailable`` status persists after a few minutes, contact us to troubleshoot the issue. + +Once the ``unavailable`` status goes away, the tenant is ready for use. If you made a free tier, You can click on that tenant and use it right away. If you made a paid or self-hosted tier, you must enter payment information before the tier is ready to use. You will see a ``payment missing`` status on that tenant. Our :doc:`billing section <./saas-billing>` will cover how to enter payment information for your tenant. + +Tenant Status +=============== + +Status indicators for each tenant are shown in the status column. + +OK +------ + +Tenant is running and functioning normally + +Payment Missing +---------------- + +There is no payment on file for that tenant. Our :doc:`billing section <./saas-billing>` will show you how to enter your payment information. + +Payment Method Invalid +------------------------ + +Double check if your payment info is correct. + +No Admin +--------- + +Your tenant does not have an admin yet. That should go away when you first sign into the tenant. If it does not, contact us to get the issue fixed. + +Error +-------- + +Could be any of multiple different issues that would cause this status. Contact us to troubleshoot. + +Unavailable +------------- + +The instance is down. This could be due to an error that caused the instance to shut down, or we could be doing maintainance on our servers. + +Manage and View Name and id +============================= + +To view the name and id of the tenant, simply go to account management and click on the settings tab. You can change the name of the tenant by clicking on the pencil icon. You can change the name to whatever you like. + +.. image:: images/saas-view-name.png + :width: 80% + :alt: name your tenant + :align: center + +Upgrade and Downgrade Your Tenant +=================================== + +Upgrade +--------- + +On a free tier tenant, you have the option to upgrade to a paid tier tenant. In the same account managemant -> settings tab there should be an upgrade option. + +.. image:: images/saas-upgrade-tenant.png + :width: 80% + :alt: upgrade tenant button + :align: center + +clicking on that should bring up a modal. + +.. image:: images/saas-upgrade-modal.png + :width: 80% + :alt: modal for tenant upgrade + :align: center + +Once you upgrade, Your netmaker instance will be disables until you enter :doc:`your payment information <./saas-billing>`. After that, you can begin using your upgraded tenant. + +Downgrade +---------- + +Before considering to downgrade, you must make sure your tenant is within the limits of the free tier. If you downgrade and are using more resources that the free tier allows, you may end up losing resources as a result. You must also make sure you do not already have a free tier on your account. You can only have one free tier at a time. + +In the same account managemant -> settings page on your paid tier. click the downgrade button. + +.. image:: images/saas-downgrade-tenant.png + :width: 80% + :alt: button to downgrade your tenant + :align: center + +A confirmation box will pop up to confirm your desision. + +Delete a Tenant +================ + +To delete a tenant, go to the same account management -> settings page and click the delete tenant button. + +.. image:: images/saas-delete-tenant.png + :width: 80% + :alt: delete your tenant + :align: center \ No newline at end of file diff --git a/saas/saas-troubleshoot.rst b/saas/saas-troubleshoot.rst new file mode 100644 index 00000000..d40f5a3a --- /dev/null +++ b/saas/saas-troubleshoot.rst @@ -0,0 +1,8 @@ +===================================== +Troubleshoot +===================================== + +Troubleshooting articles +========================== + +Our intercom system has a list of troubleshooting articles to reference `here `_ diff --git a/saas/saas-user.rst b/saas/saas-user.rst new file mode 100644 index 00000000..5b0089d7 --- /dev/null +++ b/saas/saas-user.rst @@ -0,0 +1,140 @@ +================================= +Users +================================= + +Two Different User Pages +========================= + +There are two routes to get to the users section. one is through the Users tab and the other is through the Manage Account tab. + +.. image:: images/saas-users-location.png + :width: 80% + :alt: two locations for users + :align: center + +The Manage Account route will allow you to invite users to your netmaker instance, remove users from your nemtaker instance, and transfer ownership of a netmaker instance to another user. + +The User tab route will let you manage user permissions of the users that are invited to your netmaker instance. + +Adding a User +================== + +send an invite +--------------- + +In the Manage Account section, click on the Add User button. This will bring up a modal to enter the email address of the user you would like to invite to your netmaker party. + +.. image:: images/saas-invite-user.png + :width: 80% + :alt: modal for inviting a new user + :align: center + +That user will recieve an invite via email from ``admin@mail.netmaker.io``. If the invited user has not made an account yet with ``_, now is the time to do so. + +You should see your invited user in your users section with an invite label next to it. + +.. image:: images/saas-invite-sent.png + :width: 80% + :alt: modal for inviting a new user + :align: center + + +Accept the invite +------------------ + +After the invited recieves the email. there will be a link to ``_ to access their account or create one if they have not already. + +In their account management, they should see a notification in the invite section to accept. + +.. image:: images/saas-accept-invite.png + :width: 80% + :alt: invite to accept. + :align: center + +After accepting the invite, you should see the Netmaker instance on your list of tenants. like the one in the bottom of this list. + +.. image:: images/saas-invite-accepted.png + :width: 80% + :alt: tenant list after accepting an invite. + :align: center + +you are initally invited as a non-admin user by default. The owner of the tenant will have to change your permissions if needed in the users tab. More about that will be in the next section. + +Transfer Ownership to another user +=================================== + +Make the newly joined user an admin +------------------------------------ + +Lets take our new user and transfer ownership of our tenant to it. Start by making sure the user is given admin privileges. Go to the users tab and hover over the vertical elipses. click on edit. + +.. image:: images/saas-update-user-permission.png + :width: 80% + :alt: update user permissions. + :align: center + +Click the isadmin switch and click the update user button. You should then see your invited user set to admin. + +.. image:: images/saas-user-set-to-admin.png + :width: 80% + :alt: user is admin now. + :align: center + +Transfer Ownership +------------------- + +You are now ready to transfer ownership to the new user. Navigate to account management and click on your username to bring up a bottom menu. click on the switch tenants button. + +.. image:: images/saas-navigate-to-tenant.png + :width: 80% + :alt: navigate to switch tenants + :align: center + +Navigate to the Manage Account section and go to the settings. Click on the Transfer Ownership button and you should see an option to choose the new owner from a dropdown. + +.. image:: images/saas-transfer-ownership.png + :width: 80% + :alt: transfer ownership + :align: center + +After a successful transfer, you should see the new user labeled as the owner. + +.. image:: images/saas-new-owner.png + :width: 80% + :alt: new owner + :align: center + +Leave Tenant +============= + +As an invited user to a tenant, (or after transferring ownership) you can leave a tenant. This can be done in two ways. + +Leave as an invited user +------------------------- + +Navigate to Account Management and go to settings. click the `leave tenant` button + +.. image:: images/saas-leave-tenant.png + :width: 80% + :alt: leave as non-owner + :align: center + + +Remove a User as an Owner +-------------------------- + +As an owner, navigate to the User section and click on the elipses of the user you would like to remove. + +.. image:: images/saas-remove-user.png + :width: 80% + :alt: remove user as an owner + :align: center + +After that the user should be gone from your users section and the removed user will no longer have access to that tenant. + +.. image:: images/saas-user-gone.png + :width: 80% + :alt: user is removed + :align: center + +