Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
fd7e049
SEO for GoLang
ajeetraina Apr 26, 2022
507cb3f
Python SEO
ajeetraina Apr 26, 2022
2820373
Added SEO for Php
ajeetraina Apr 27, 2022
4c53909
Added SEO for FastAPI
ajeetraina Apr 27, 2022
1c58a2e
SEO for Ruby
ajeetraina Apr 27, 2022
1ed78c9
SEO for Ruby
ajeetraina Apr 27, 2022
573f721
SEO for Hacker News
ajeetraina Apr 27, 2022
5713ae0
Update docs/create/heroku/portal/index-heroku.mdx
ajeetraina Apr 27, 2022
ff3c0d0
Update docs/create/heroku/portal/index-heroku.mdx
ajeetraina Apr 27, 2022
470c41d
Update docs/develop/golang/index-golang.mdx
ajeetraina Apr 27, 2022
b1770d0
Update docs/develop/golang/index-golang.mdx
ajeetraina Apr 27, 2022
27f7693
Update docs/develop/ruby/index-ruby.mdx
ajeetraina Apr 27, 2022
1c7ff14
Update docs/develop/ruby/index-ruby.mdx
ajeetraina Apr 27, 2022
b452a1e
Update docs/develop/ruby/index-ruby.mdx
ajeetraina Apr 27, 2022
527f219
Update docs/howtos/hackernews/index-hackernews.mdx
ajeetraina Apr 27, 2022
cf75654
Update docs/howtos/hackernews/index-hackernews.mdx
ajeetraina Apr 27, 2022
d460907
Update docs/develop/golang/index-golang.mdx
ajeetraina Apr 27, 2022
668dd81
Update docs/develop/golang/index-golang.mdx
ajeetraina Apr 27, 2022
fe846ab
Update docs/develop/golang/index-golang.mdx
ajeetraina Apr 27, 2022
e7596de
Update docs/develop/golang/index-golang.mdx
ajeetraina Apr 27, 2022
17dff16
Update docs/develop/golang/index-golang.mdx
ajeetraina Apr 27, 2022
bfa7970
Update docs/develop/java/getting-started/index.md
ajeetraina Apr 27, 2022
30029db
Update docs/develop/java/getting-started/index.md
ajeetraina Apr 27, 2022
40925d8
Update docs/develop/java/getting-started/index.md
ajeetraina Apr 27, 2022
a50c06b
Update docs/develop/node/gettingstarted/index-gettingstarted.mdx
ajeetraina Apr 27, 2022
7c278e4
Update docs/develop/node/gettingstarted/index-gettingstarted.mdx
ajeetraina Apr 27, 2022
873c5f1
Update docs/develop/node/gettingstarted/index-gettingstarted.mdx
ajeetraina Apr 27, 2022
22b7628
Update docs/develop/node/gettingstarted/index-gettingstarted.mdx
ajeetraina Apr 27, 2022
8f2d3f4
Update docs/develop/node/gettingstarted/index-gettingstarted.mdx
ajeetraina Apr 27, 2022
83e237e
Update docs/develop/node/gettingstarted/index-gettingstarted.mdx
ajeetraina Apr 27, 2022
8951e4b
Update docs/develop/php/index-php.mdx
ajeetraina Apr 27, 2022
1039522
Update docs/develop/php/index-php.mdx
ajeetraina Apr 27, 2022
926098b
Update docs/develop/php/index-php.mdx
ajeetraina Apr 27, 2022
05a6ca8
Update docs/develop/php/index-php.mdx
ajeetraina Apr 27, 2022
29b0e47
Update docs/develop/python/fastapi/index-fastapi.mdx
ajeetraina Apr 27, 2022
2469cdd
Update docs/develop/python/index-python.mdx
ajeetraina Apr 27, 2022
817af30
Update docs/develop/python/index-python.mdx
ajeetraina Apr 27, 2022
c7384be
Update docs/develop/python/index-python.mdx
ajeetraina Apr 27, 2022
6f48a3d
Update docs/develop/python/index-python.mdx
ajeetraina Apr 27, 2022
d0dcd63
Update docs/develop/python/index-python.mdx
ajeetraina Apr 27, 2022
122c3be
Update docs/develop/python/index-python.mdx
ajeetraina Apr 27, 2022
fef2dc2
Update docs/develop/python/index-python.mdx
ajeetraina Apr 27, 2022
018bad4
Update docs/develop/python/index-python.mdx
ajeetraina Apr 27, 2022
e9d73b1
Update docs/develop/python/index-python.mdx
ajeetraina Apr 27, 2022
31b16f5
Update docs/develop/python/index-python.mdx
ajeetraina Apr 27, 2022
e30ab45
Update docs/develop/ruby/index-ruby.mdx
ajeetraina Apr 27, 2022
1e1ece0
Update docs/develop/ruby/index-ruby.mdx
ajeetraina Apr 27, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions docs/create/heroku/portal/index-heroku.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,15 @@ Heroku is a cloud Platform as a Service (PaaS) supporting multiple programming l

### Using Redis Enterprise Cloud directly

Redis is an open source, in-memory, key-value data store most commonly used as a primary database, cache, message broker, and queue. Redis cache delivers sub-millisecond response times, enabling fast and powerful real-time applications in industries such as gaming, fintech, ad-tech, social media, healthcare, and IoT.

Redis Cloud is a fully-managed cloud service for hosting and running your Redis dataset in a highly-available and scalable manner, with predictable and stable top performance. Redis Enterprise cloud allows you to run Redis server over the Cloud and access instance via multiple ways like RedisInsight, redis command line as well as client tools. You can quickly and easily get your apps up and running with Redis Cloud through its Redis Heroku addons , just tell us how much memory you need and get started instantly with your first Redis database. You can then add more Redis databases (each running in a dedicated process, in a non-blocking manner) and increase or decrease the memory size of your plan without affecting your existing data.

::tip INFO
Heroku addons are set of tools and services for developing, extending, and operating your app.
:::



You can quickly and easily get your apps up and running with Redis Enterprise Cloud directly. Follow the below steps:

Expand All @@ -47,6 +56,8 @@ For a limited time, use **TIGER200** to get **$200** credits on Redis Enterprise

[Follow this link to create a Redis Enterprise Cloud](/create/rediscloud) subscription and database. Once you create the database, you will be provisioned with a unique database endpoint URL, port and password. Save these for future reference.

Before you proceed with heroku redis, ensure that you can connect to Redis instance and verify if it is accessible via redis-cli command. You can run `info` command that is available in redis client software to see the version, memory usage, stats, and modules enabled in the Redis cloud database.

#### Step 2. Create a Heroku account

If you are using Heroku for the first time, create your new Heroku account [through this link](https://signup.heroku.com/login).
Expand Down Expand Up @@ -98,8 +109,7 @@ Run the commands below to get a functioning Git repository that contains a simpl

#### Step 6. Setting up environment variables

[Follow this link to create a Redis Enterprise Cloud](/create/rediscloud) subscription and database as shown below:
Go to the Heroku dashboard, click "Settings" and set `REDIS_ENDPOINT_URI` and `REDIS_PASSWORD` under the Config Vars.(Please note that the database endpoint is unique and might be different in your case. Please enter the values accordingly)
[Follow this link to create a Redis Enterprise Cloud](/create/rediscloud) subscription and database connection as shown below: Go to the Heroku dashboard, click "Settings" and set `REDIS_URL` and `REDIS_PASSWORD` under the Config Vars. (Please note that the Redis URL endpoint is unique and might be different in your case. Please enter the values accordingly)

Refer to [Step 1](/create/heroku/portal#step-1-create-redis-enterprise-cloud) for the correct values to use.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -252,9 +252,15 @@ Kubernetes makes physical storage devices available to your cluster in the form

An Operator is basically an application-specific controller that can help you manage a Kubernetes application. It is a way to package, run, and maintain a Kubernetes application. It is designed to extend the capabilities of Kubernetes, and also simplify application management. This is especially useful for stateful applications, which include persistent storage and other elements external to the application, and may require extra work to manage and maintain.

### Functions of Kubernetes Operator

A Kubernetes Operator uses the Kubernetes API to create, configure, and manage instances of complex stateful applications on behalf of a Kubernetes user. There is a public repository called [OperatorHub.io](https://operatorhub.io) that is designed to be the public registry for finding Kubernetes Operator backend services. With Operator Hub, developers can easily create an application based on an operator without going through the complexity of crafting an operator from scratch.
:::info TIP
The Operator Framework is an open source project that provides developer and runtime Kubernetes tools, enabling you to accelerate the development of an operator.
[Learn more about operator framework here](https://operatorframework.io/)
:::

### Functions of Kubernetes Operators

A Kubernetes Operator uses the Kubernetes API server to create, configure, and manage instances of complex stateful applications on behalf of a Kubernetes user. There is a public repository called [OperatorHub.io](https://operatorhub.io) that is designed to be the public registry for finding Kubernetes Operator backend services. With Operator Hub, developers can easily create an application based on an operator without going through the complexity of crafting an operator from scratch.

![alt_text](images/image6.png)

Expand All @@ -278,7 +284,7 @@ Below are a few examples of popular Kubernetes Operators and their functions and
### How does an Operator work?


Operators work by extending the Kubernetes control plane and API. Operators allows you to define a Custom Controller that watches your application and performs custom tasks based on its state. The application you want to watch is usually defined in Kubernetes as a new object: a [Custom Resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) (CR) that has its own YAML spec and object type that is well understood by the API server. That way, you can define any specific criteria in the custom spec to watch out for, and reconcile the instance when it doesn’t match the spec. The way an Operator’s controller reconciles against a spec is very similar to native Kubernetes controllers, though it is using mostly custom components.
Operators work by extending the Kubernetes control plane and API server. Operators allows you to define a Custom Controller that watches your application and performs custom tasks based on its state. The application you want to watch is usually defined in Kubernetes as a new object: a [Custom Resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) (CR) that has its own YAML spec and object type that is well understood by the API server. That way, you can define any specific criteria in the custom spec to watch out for, and reconcile the instance when it doesn’t match the spec. The way an Operator’s controller reconciles against a spec is very similar to native Kubernetes controllers, though it is using mostly custom components.

### What is the Redis Enterprise Operator?

Expand Down Expand Up @@ -379,3 +385,4 @@ In the next tutorial, you will learn how to get started with the Redis Enterpris
* [Redis Enterprise Software on Kubernetes architecture ](https://docs.redis.com/latest/kubernetes/deployment/quick-start/)
* [Installing RedisInsight using Helm chart](/explore/redisinsight/usinghelm)
* [Deploy Redis Enterprise Software on Kubernetes](https://docs.redis.com/latest/kubernetes/deployment/quick-start/)
* [Operator Framework](https://operatorframework.io/)
19 changes: 12 additions & 7 deletions docs/develop/golang/index-golang.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -146,21 +146,25 @@ Do check [Redis Cache Library for Golang](https://github.com/go-redis/cache)

#### Step 1. Run a Redis server

You can run a Redis database directly over your local mac os or in a container.
If you have Docker installed in your sytem, type the below command:
Redis is an open source, in-memory, key-value data store most commonly used as a primary database, cache, message broker, and queue. Redis delivers sub-millisecond response times, enabling fast and powerful real-time applications in industries such as gaming, fintech, ad-tech, social media, healthcare, and IoT. You can run a Redis database directly over your local mac os or in a container. If you have Docker installed in your sytem, type the following command:

```bash
docker run -d -p 6379:6379 redislabs/redismod
```

You can verify if Redis database using the below redis command:
You can connect to Redis server using the `redis-cli` command like this:

```
redis-cli -p 6379
redis-cli
```

The above command will make a connection to the Redis server. It will then present a prompt that allows you to run Redis commands.


#### Step 2. Initialise the Go Module

In order to connect to the Redis instance and return some data value, first you need to initialize the Go module as shown:

```bash
go mod init github.com/my/repo
```
Expand All @@ -173,7 +177,9 @@ You can verify if Redis database using the below redis command:

#### Step 4. Create a main.go file

Let us create a main.go file and write the following code to check for your connection
Let us create a `main.go` file and write the following code to check for your Redis instance connection



```bash
package main
Expand Down Expand Up @@ -205,8 +211,7 @@ func main() {
go run main.go
```

By now, the Go application should successfully connect to the Redis instance and return a successful PONG response.

By now, the Go application should successfully connect to the Redis instance and return data value (a successful "PONG" response).


</TabItem>
Expand Down
30 changes: 29 additions & 1 deletion docs/develop/java/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,35 @@ The blog post “[Jedis vs. Lettuce: An Exploration](https://redis.com/blog/jedi
]}>
<TabItem value="jedis">

## Using Jedis
Redis is an open source, in-memory, key-value data store most commonly used as a primary database, cache, message broker, and queue. Redis delivers sub-millisecond response times, enabling fast and powerful real-time applications in industries such as gaming, fintech, ad-tech, social media, healthcare, and IoT.


### Run a Redis server

You can either run Redis in a Docker container or directly on your machine.
Use these commands to setup a Redis server locally on Mac OS:


```
brew tap redis-stack/redis-stack
brew install --cask redis-stack
```

:::info INFO
Redis Stack unifies and simplifies the developer experience of the leading Redis modules and the capabilities they provide. Redis Stack bundles five Redis modules: RedisJSON, RedisSearch, RedisGraph, RedisTimeSeries, and RedisBloom.
[Learn more](/create/redis-stack)
:::


Ensure that you are able to use the following Redis command to connect to the Redis instance.

```bash
redis-cli
localhost>
```


### Using Jedis

### Step 1. Add dependencies Jedis dependency to your Maven (or Gradle) project file:

Expand Down
17 changes: 11 additions & 6 deletions docs/develop/node/gettingstarted/index-gettingstarted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Find tutorials, examples and technical articles that will help you to develop wi

## Introduction

Redis is an open source, in-memory, key-value data store most commonly used as a primary database, cache, message broker, and queue. Redis cache delivers sub-millisecond response times, enabling fast and powerful real-time applications in industries such as gaming, fintech, ad-tech, social media, healthcare, and IoT.

Redis is a great database for use with Node. Both Redis and Node share similar type conventions and threading models, which makes for a very predictable development experience. By pairing Node and Redis together you can achieve a scalable and productive development platform.

Redis has two primary Node clients which are [node-redis](https://github.com/redis/node-redis) and [ioredis](https://github.com/luin/ioredis). Both are available through npm. We generally suggest using node-redis, as it has wide support for Redis modules, is easily extended, and is widely used.
Expand All @@ -35,7 +37,7 @@ This article shows how to get started with the recommended libraries: [node-redi
#### Step 1. Run a Redis server

You can either run Redis in a Docker container or directly on your Mac OS.
Follow the below commands to setup a Redis server locally:
Use the following commands to setup a Redis server locally:


```
Expand All @@ -44,21 +46,22 @@ Follow the below commands to setup a Redis server locally:
```

:::info INFO
Redis Stack unifies and simplifies the developer experience of the leading Redis modules and the capabilities they provide. Redis Stack bundles five Redis modules: RedisJSON, RedisSearch, RedisGraph, RedisTimeSeries, and RedisBloom.
Redis Stack unifies and simplifies the developer experience of the leading Redis data store, modules and the capabilities they provide. Redis Stack bundles five Redis modules: RedisJSON, RedisSearch, RedisGraph, RedisTimeSeries, and RedisBloom.
[Learn more](/create/redis-stack)
:::


Ensure that you are able to use the following Redis command to connect to the Redis instance.

```bash
redis-cli -h localhost -p 6379
redis-cli
localhost>
```
Now you should be able to perform CRUD operations with Redis keys.
The above Redis client command might require password if you have setup authentication in your Redis configuration file. Refer [Redis Command Reference](https://redis.io/commands/)
#### Step 2. Install node redis using `NPM` (or `YARN`)

#### Step 2. Install node-redis using `npm` (or `yarn`)

Run the following NPM command line to install Redis client.
Run the following NPM command to install the Redis client.

```bash
npm install redis
Expand All @@ -67,6 +70,8 @@ Run the following NPM command line to install Redis client.

#### Step 2. Write your Application Code

Use the following sample code for our Node.js application:

```javascript
import { createClient } from 'redis';

Expand Down
29 changes: 9 additions & 20 deletions docs/develop/php/index-php.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,12 @@ In order to use Redis with PHP you will need a PHP Redis client. In the followin



<Tabs
defaultValue="Phpredis"
values={[
{label: 'Phpredis', value: 'Phpredis'},
]}>
<TabItem value="Phpredis">

Redis is an open source, in-memory, key-value data store most commonly used as a primary database, cache, message broker, and queue. Redis delivers sub-millisecond response times, enabling fast and powerful real-time applications in industries such as gaming, fintech, ad-tech, social media, healthcare, and IoT.
Redis is an open source, in-memory, key-value data store most commonly used as a primary database, cache, message broker, and queue. Redis cache delivers sub-millisecond response times, enabling fast and powerful real-time applications in industries such as gaming, fintech, ad-tech, social media, healthcare, and IoT.


#### Step 1. Run a Redis server

You can either run Redis in a Docker container or directly on your Mac OS.
Follow the below commands to setup a Redis server locally:

You can either run Redis server in a Docker container or directly on your machine. Follow the below command to setup a Redis server locally on Mac OS:

```
brew tap redis-stack/redis-stack
Expand All @@ -54,7 +45,7 @@ Ensure that you are able to use the following Redis command to connect to the Re
redis-cli -h localhost -p 6379
localhost>
```

Now you should be able to perform CRUD operations with Redis keys. The above Redis client command might require password if you have setup authentication in your Redis configuration file. If a Redis password is not set, then it will perform the default connection to Redis server. You can play around inserting data to Redis using `SET` and then fetching it back with the `GET` command.

### Step 2. Get pecl

Expand All @@ -65,13 +56,13 @@ apt install pkg-php-tools



### Step 2. Install PhpRedis
### Step 3. Install PhpRedis

```
pecl install redis
```

### Step 3. Opening a Connection to Redis Using PhpRredis
### Step 4. Opening a Connection to Redis Using PhpRredis

The following code creates a connection to Redis using Phpredis

Expand All @@ -90,9 +81,9 @@ if ($redis->ping()) {
?>
```

Replace the following values with those of your database and save this file as connect.php
Replace the following values with those of your database and save this file as `connect.php`.

### Step 4. Executing the script
### Step 5. Executing the script

```
php connect.php
Expand All @@ -113,11 +104,9 @@ OK
- [Getting Started with Redis & Php](https://github.com/redis-developer/redis-php-getting-started/)
- [PHP extension for Redis based on Hiredis](https://github.com/nrk/phpiredis)
- [Redis distributed locks in PHP](https://github.com/ronnylt/redlock-php)
- [Support for Redis Cluster ](https://github.com/phpredis/phpredis/blob/develop/cluster.markdown#redis-cluster)

- [Support for Redis Cluster](https://github.com/phpredis/phpredis/blob/develop/cluster.markdown#redis-cluster)
- [Support for Redis Sentinel](https://github.com/phpredis/phpredis/blob/develop/sentinel.markdown#readme)

</TabItem>
</Tabs>


<div>
Expand Down
3 changes: 1 addition & 2 deletions docs/develop/python/fastapi/index-fastapi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,7 @@ RedisTimeSeries is a source available Redis Module that adds a timeseries data t

You can get started by following the [setup instructions](https://oss.redis.com/redistimeseries/#setup) in the RedisTimeSeries documentation.

However, note that this tutorial's example project configures RedisTimeSeries automatically for you with the [redismod](https://hub.docker.com/r/redislabs/redismod) Docker image.

However, note that this tutorial's example project configures RedisTimeSeries automatically for you with the redismod Docker image. You can even use Docker Compose to build up your Redis server.

## An Asyncio Primer

Expand Down
Loading