Skip to content

Commit

Permalink
update docs for v0.7
Browse files Browse the repository at this point in the history
  • Loading branch information
Nidheesh-Panchal committed Jul 19, 2024
1 parent f146634 commit af5eebf
Show file tree
Hide file tree
Showing 7 changed files with 44 additions and 2 deletions.
8 changes: 7 additions & 1 deletion docs/source/getting_started/deploy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@ Setup Lambda repository
$ docker tag public.ecr.aws/p2d2x2s3/cypienta/vrl-lambda:v0.1 ${ECR_URI}/${REPO_NAME}:v0.1
$ docker push ${ECR_URI}/${REPO_NAME}:v0.1
7. Copy the ECR Image URI and make a note of it to use in CloudFormation template

.. code-block:: shell
$ echo ${ECR_URI}/${REPO_NAME}:v0.1
Deploy resources using the Cloud Formation template
---------------------------------------------------
Expand Down Expand Up @@ -107,7 +113,7 @@ Deploy resources using the Cloud Formation template

**NginxContainerImage:** The container image of the subscribed marketplace UI product with tag ``nginx-market*``. The ``Nginx container image`` noted in the section :doc:`subscribe`.

**VRLLambdaImage:** The container image of the VRL Lambda that was pushed to ECR private repository in :ref:`my-heading`
**VRLLambdaImage:** The container image of the VRL Lambda that was pushed to ECR private repository in :ref:`setup_lambda_repository`

The constraints for choosing the ``Cpu`` and ``Memory`` for the cluster can be found `here <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html#cfn-ecs-taskdefinition-cpu>`__

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 37 additions & 1 deletion docs/source/splunk/splunk.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,42 @@
Configure Splunk
================

Getting AWS Access key
----------------------

To get data from and to S3, the Apps for Splunk would require Access keys from AWS. Follow the steps below to get Access key. If you already have Access key and corresponding Secret key, you can skip to :ref:`getting_data_from_splunk`

1. Navigate to AWS console and search for ``IAM``.

2. On the left hand side panel, under ``Access Management``, select ``Users``

.. image:: splunk_resources/iam_users_panel.png
:alt: select users from panel
:align: center

3. Click on the user for whom you want to create Access key. Select the tab ``Security credentials`` and find ``Access keys`` section. Click on ``Create access key`` button on top right of the section.

.. image:: splunk_resources/access_key_tab.png
:alt: select users from panel
:align: center

4. On the ``Access key best practices & alternatives`` page, select ``Other`` and click on ``Next``.

.. image:: splunk_resources/other_access_key.png
:alt: select other
:align: center

5. Set an optional description tag for the access key and click on ``Create access key``.

6. Make note of the ``Access key`` and ``Secret access key`` to use in later steps. You may also download .csv file by clicking on ``Download .csv file``.

.. image:: splunk_resources/copy_access_key.png
:alt: copy access key
:align: center


.. _getting_data_from_splunk:

Getting data from Splunk to S3
------------------------------

Expand All @@ -25,7 +61,7 @@ To get search results of Splunk to AWS S3. Follow the steps below:

4. On the configuration page. Click on the ``Account`` tab, and click on ``Add`` to add an AWS account.

Then click on the ``IAM Role`` tab, and add an IAM role that has ``write`` permissions to S3.
Then click on the ``IAM Role`` tab, and add an IAM role that has ``write`` permissions to S3. You can use the ARN of IAM role created by the CloudFormation template for Lambda.

In the ``Logging`` tab, the ``Log level`` is set to ``INFO`` by default, modify it as required.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit af5eebf

Please sign in to comment.