Acc 232 saas docs

index.rst

@@ -112,6 +112,17 @@ Enterprise Documentation
    ee/index
 
 
+SAAS Documentation
+---------------------------
+
+.. toctree::
+   :maxdepth: 2
+
+   saas/index
+
+
+
+
 Advanced Server Installation
 -------------------------------
 

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
+

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, <https://app.netmaker.io/>`_ 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

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
+

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 [email protected]``. 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>` . 

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